Skip to content

endatabas/endb-book

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

endb-book

The Endatabas Book

Setup

Clone the main endb repo in a sibling directory with endb-book:

cd .. && git clone [email protected]:endatabas/endb.git && cd endb-book

Make sure you have cargo, npm, and pip (Rust, Node, and Python) installed. Then run:

cargo install mdbook
cargo install mdbook-linkcheck

npm install -g jsdoc
npm install -g jsdoc-to-markdown

pip install sphinx
pip install sphinx-markdown-builder                                                                                                                                                    │
pip install sphinx-autodoc-typehints

Build

make
make serve  # to view locally

Limitations

  • There is no mdbook-pdf but the HTML print feature works reasonably well.

Inspiration

TODO

  • beef up tutorial
  • remove code example overflows

TODO: Feedback Required / Later

  • NorthWind equivalent?
  • docker/podman --pull=always (doesn't work in podman 3.4.4, which is in the 22.04 repo)

Releases

No releases published

Packages

No packages published