The best way to publish your scientific knowledge.
OurBigBook.com | docs.OurBigBook.com
Source code for the entire OurBigBook Project:
OurBigBook is a powerful static wiki generator and lightweight markup language to write complex structured wikis/books/blogs.
The same markup source code can also be uploaded to OurBigBook.com which has the amazing "Topics" multi-user mind-melding magic feature 🧙
A rendered version of it can be seen at: https://docs.ourbigbook.com. The source file for the homepage is: index.bigb.
Get started quickly with the OurBigBook command line utility by using our template project https://github.com/ourbigbook/template:
git clone https://github.com/ourbigbook/template
cd template
npm install
npx ourbigbook .
firefox _out/html/index.html
firefox _out/html/not-index.html
The generated HTML is published at: https://ourbigbook.github.io/template
A full blown showcase knowledge base can be seen at:
- https://cirosantilli.com (static website publish)
- https://ourbigbook.com/cirosantilli (equivalent on OurBigBook.com with dynamic website features such as topics
- https://github.com/cirosantilli/cirosantilli.github.io (source code for both of the above)
Screenshot of the topics feature, which provides multi-user mind-melding:
Internal cross file references done right:
You can edit locally with our Visual Studio Code extension:
The Visual Studio Code extension implements features such as header trees:
You can also edit directly on OurBigBook.com with the Web Editor:
Tags are just headers:
If ID prefixes are getting too repetitive, we have ID scopes for you:
Experience infinitely deep tables of contents:
Every single section gets its own discussion section so you can find issues specific to any part of the text:
Send an email with a link to your articles to your followers with the article announcement feature:
Send an email with a link to your articles to your followers with the article announcement feature:
You can create OurBigBook articles that talk about specific files such as images or source code with the file feature:
You can create OurBigBook articles that talk about specific files such as images or source code with the file feature:
With automatic topic linking, regular text gets automatically converted to links to topics if part of the text matches an existing topic:
