aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJieiku2022-05-31 01:45:54 -0700
committerJieiku2022-05-31 01:45:54 -0700
commitd4a052e86f33ced79b9f4d09aeee0b1c43ef1f23 (patch)
tree68b40eed2c6047850d25f5d812d596cb74a2cd96 /README.md
parent6719a3b149ec630aacec164df325de1b61221761 (diff)
downloadabridge-d4a052e86f33ced79b9f4d09aeee0b1c43ef1f23.tar.gz
abridge-d4a052e86f33ced79b9f4d09aeee0b1c43ef1f23.tar.bz2
abridge-d4a052e86f33ced79b9f4d09aeee0b1c43ef1f23.zip
Improve imghover shortcode, examples, page scores
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 12 insertions, 6 deletions
diff --git a/README.md b/README.md
index 27ecee1..1244c47 100644
--- a/README.md
+++ b/README.md
@@ -56,18 +56,24 @@ Enable the theme in your `config.toml` in the site directory:
theme = "abridge"
```
-Or copy the `config.toml` from the theme directory to your project's
-root directory, and uncomment the theme line:
+Or copy the `config.toml` from the theme directory to your project's root directory:
+(This will give you a base configuration with all config values used)
```bash
cp themes/abridge/config.toml config.toml
-sed -i 's/^#theme = "abridge"/theme = "abridge"/' config.toml
```
-Also point extra_syntaxes_and_themes at the correct directory:
-
+Uncomment the theme line, and point extra_syntaxes_and_themes at the correct directory:
+```bash
+sed -i 's/^#theme = "abridge"/theme = "abridge"/' config.toml
+sed -i 's/^extra_syntaxes_and_themes = \["highlight_themes"\]/extra_syntaxes_and_themes = \["highlight_themes", "themes\/abridge\/highlight_themes"\]/' config.toml
```
-extra_syntaxes_and_themes = ["themes/abridge/highlight_themes"]
+
+The result should be:
+```toml
+theme = "abridge"
+[markdown]
+extra_syntaxes_and_themes = ["highlight_themes", "themes/abridge/highlight_themes"]
```
### Step 4: Add new content