Use <!--{{...}}--> for placeholders in README

This commit is contained in:
Maddison Hellstrom 2017-12-01 19:10:34 -08:00
parent cbb6344e9e
commit b60e17432c
2 changed files with 8 additions and 8 deletions

View File

@ -1,4 +1,4 @@
<!--DISCLAIMER-->
<!--{{DISCLAIMER}}-->
### Maddy's SurfingKeys Configuration
This is my personal configuration for the wonderful [SurfingKeys](https://github.com/brookhong/Surfingkeys) Chrome Extension.
@ -12,7 +12,7 @@ This is my personal configuration for the wonderful [SurfingKeys](https://github
#### Bundled Search Engine Completions
There are currently <!--COMPL_COUNT--> Search Engine auto-completions.
There are currently <!--{{COMPL_COUNT}}--> Search Engine auto-completions.
You can access a Search Engine auto-completion by pressing the search leader key, which is `a` by default, followed by the search engine alias.
@ -20,7 +20,7 @@ For example, to open the Wikipedia completion, you would type `awp` while in nor
| Alias | Name | Domain | Screenshots |
| ---- | ------ | ----- | ----- |
<!--COMPL_TABLE-->
<!--{{COMPL_TABLE}}-->
#### Installation
@ -83,7 +83,7 @@ The final step is to tell SurfingKeys where to find your configuration file:
If you ever make a change to any of your configuration files in the future, simply run `gulp install` again and your settings will be immediately updated.
#### Screenshots
<!--SCREENSHOTS-->
<!--{{SCREENSHOTS}}-->
#### Todo

View File

@ -100,10 +100,10 @@ gulp.task("readme", () => {
return `${a}| \`${c.alias}\` | \`${c.name}\` | \`${domain}\` | ${s} |\n`
}, "")
return gulp.src(["./README.tmpl.md"])
.pipe(replace("<!--DISCLAIMER-->", disclaimer))
.pipe(replace("<!--COMPL_COUNT-->", Object.keys(compl).length))
.pipe(replace("<!--COMPL_TABLE-->", table))
.pipe(replace("<!--SCREENSHOTS-->", screenshotList))
.pipe(replace("<!--{{DISCLAIMER}}-->", disclaimer))
.pipe(replace("<!--{{COMPL_COUNT}}-->", Object.keys(compl).length))
.pipe(replace("<!--{{COMPL_TABLE}}-->", table))
.pipe(replace("<!--{{SCREENSHOTS}}-->", screenshotList))
.pipe(rename("README.md"))
.pipe(gulp.dest("."))
})