https://github.com/bluerock-io/auto-docs
BlueRock Automation Docs
https://github.com/bluerock-io/auto-docs
cpp formal-methods formal-verification rocq-prover
Last synced: 10 months ago
JSON representation
BlueRock Automation Docs
- Host: GitHub
- URL: https://github.com/bluerock-io/auto-docs
- Owner: bluerock-io
- Created: 2025-07-23T12:43:59.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-09-16T13:26:18.000Z (10 months ago)
- Last Synced: 2025-09-16T15:42:28.357Z (10 months ago)
- Topics: cpp, formal-methods, formal-verification, rocq-prover
- Language: Rocq Prover
- Homepage: https://bluerock-io.github.io/auto-docs/
- Size: 356 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Micro Docs
To install dependencies, run
```sh
npm install
```
To serve the website, run
```sh
npm run watch
```
### Input syntax
To add a new tutorial:
- Create a folder under `fmdeps/micro-docs/content/docs/`
- Add a `foo.v` file with the content, and a `foo.11tydata.json` file with
metadata: the title is used at the top of the document, and
`tags`/`requires`/`provides` are metadata that is not used yet.
- Add the new tutorial to `fmdeps/micro-docs/content/_data/sidebar.yaml`; the
title there will be used in the sidebar.
XXX: This title should match the one in metadata, they'll be unified later.
The `.v` files are converted to HTML by using syntax highlighting on the Rocq code.
Comments using `(*@@ Markdown Text with LiquidJS Tags *)` are converted to paragraphs
"outside" the code blocks; probably avoid such comments "inside" Rocq sentences,
the output is odd.
The syntax can use Liquid Tags http://liquidjs.com/tags/overview.html.
You can also hide Rocq code from the output as follows:
```
(*@HIDE@*)
... whole Rocq sentences to hide from output.
(*@END-HIDE@*)
```