nikon/docsearch
1
0
Fork 0
Code Activity Actions

docs(documentation.md): Fix not working links

Browse source 
Closes #65
This commit is contained in:
Matthieu Dumont 2016-01-27 14:55:10 +01:00
parent b14e59f946
commit 71b652bd92
2 changed files with 15 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -40,7 +40,7 @@ Check out our [website][1] to add an outstanding search to your documentation.
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
<!-- START documentation.md -->
<!-- START documentation -->
## Introduction
@ -194,7 +194,7 @@ docsearch({
You will find all Algolia API options in its [own documentation][23]
<!-- END documentation.md -->
<!-- END documentation -->
## Development workflow
@ -248,6 +248,7 @@ configure the build path of eventmachine with
bundle config build.eventmachine --with-cppflags=-I$(brew --prefix openssl)/include
```
<!-- START links -->
[1]: https://community.algolia.com/docsearch/
[2]: https://img.shields.io/npm/v/docsearch.js.svg?style=flat-square
@ -276,3 +277,5 @@ bundle config build.eventmachine --with-cppflags=-I$(brew --prefix openssl)/incl
[25]: https://jekyllrb.com/
[26]: https://www.ruby-lang.org/en/
[27]: http://bundler.io/
<!-- END links -->

15
scripts/build-docs
View file

@ -5,15 +5,19 @@ set -o errexit
readonly SOURCE=README.md
readonly OUTPUT=docs/documentation.md
readonly START_TAG="<!-- START documentation.md -->"
readonly END_TAG="<!-- END documentation.md -->"
readonly START_DOC_TAG="<!-- START documentation -->"
readonly END_DOC_TAG="<!-- END documentation -->"
readonly START_LINKS_TAG="<!-- START links -->"
readonly END_LINKS_TAG="<!-- END links -->"
function escape_regex {
echo "$@" | sed -e 's/[]\/\!$*.^|[]/\\&/g'
echo "$1" | sed -e 's/[]\/\!$*.^|[]/\\&/g'
}
function extract {
sed -n "/^\s*$(escape_regex $START_TAG)\s*$/,/^\s*$(escape_regex $END_TAG)\s*$/p" \
sed -n "/^\s*$(escape_regex "$1")\s*$/,/^\s*$(escape_regex "$2")\s*$/p" \
| sed '$d' \
| sed -n '2,$p'
}
@ -27,7 +31,8 @@ function main {
echo "permalink: /documentation/" >> $OUTPUT
echo "---" >> $OUTPUT
cat $SOURCE | extract >> $OUTPUT
cat $SOURCE | extract "$START_DOC_TAG" "$END_DOC_TAG" >> $OUTPUT
cat $SOURCE | extract "$START_LINKS_TAG" "$END_LINKS_TAG" >> $OUTPUT
}
main