This is the template for the https://w3c.github.io/N3 website (builtin function section).
Current version: https://domel.github.io/n3builtins/specification/
Requirements are written in Markdown and transformed to HTML using the Bikeshed preprocessor.
These tools are required for testing and development of the documentation:
- Jupyter
- Docker with a Bikeshed image
- Python with modules (hint:
python -m pip install <module>
)- notebook
- pandas
- sparql_dataframe
- urlib3
- EYE
- rapper
Note: when editing the create-markdown.ipynb
Jupyter notebook, be sure to convert it to a Python file afterwards:
jupyter nbconvert --to script 'create-markdown.ipynb' --output 'create-markdown'
See : spec/
folder.
make builtins
: generate a N3builtins.n3
file fromsrc/
input filesmake valid
: validate allsrc/
input filesmake tidy
: generate builtins.tidy.n3 that is human-readable
make index
: generate aindex.bs
document
Choose one of:
make spec
: generate HTMLindex.html
fromindex.bs
(docker)make watch
: run a watcher program onindex.bs
(continuous development)make web
: generate HTMLindex.html
fromindex.bs
(without using docker)