forked from glen/fostr
docs: Get mkdocs working
This commit is contained in:
parent
7b00b01856
commit
527f802793
3
docs/extra.css
Normal file
3
docs/extra.css
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
ins {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
@ -7,15 +7,17 @@ nav:
|
|||||||
plugins:
|
plugins:
|
||||||
- search
|
- search
|
||||||
- semiliterate:
|
- semiliterate:
|
||||||
ignore_folders: [target]
|
ignore_folders: [target, lib]
|
||||||
exclude_extensions: ['.o', '.hi']
|
exclude_extensions: ['.o', '.hi']
|
||||||
extract_standard_markdown:
|
extract_standard_markdown:
|
||||||
terminate: <!-- /md -->
|
terminate: <!-- /md -->
|
||||||
theme:
|
theme:
|
||||||
name: readthedocs
|
name: readthedocs
|
||||||
|
prev_next_buttons_location: both
|
||||||
|
extra_css: [extra.css]
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
- attr_list
|
- attr_list
|
||||||
- markdown-del-ins
|
- markdown_del_ins
|
||||||
- pymdownx.superfences
|
- pymdownx.superfences
|
||||||
- pymdownx.highlight:
|
- pymdownx.highlight:
|
||||||
use_pygments: true
|
use_pygments: true
|
||||||
|
@ -35,14 +35,14 @@ cloning this fostr project. Then, either:
|
|||||||
|
|
||||||
For example, this snippet generates the following Python:
|
For example, this snippet generates the following Python:
|
||||||
```python
|
```python
|
||||||
{! ../examples/emit_sum.py extract:
|
{! ../tests/emit_sum.py extract:
|
||||||
start: 'Stdio\s='
|
start: 'Stdio\s='
|
||||||
!}
|
!}
|
||||||
```
|
```
|
||||||
(which writes "192" to standard output), or this non-idiomatic, inefficient, but
|
(which writes "192" to standard output), or this non-idiomatic, inefficient, but
|
||||||
working Javascript:
|
working Javascript:
|
||||||
```javascript
|
```javascript
|
||||||
{! ../examples/emit_sum.js extract:
|
{! ../tests/emit_sum.js extract:
|
||||||
start: '^}'
|
start: '^}'
|
||||||
!}
|
!}
|
||||||
```
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user