OurBigBook logoOurBigBook Docs OurBigBook logoOurBigBook.comSite Source code

OurBigBook Project

OurBigBook.com: The OurBigBook Project is creating the ultimate open source tools to publish textbooks/personal knowledge bases/Zettelkasten/digital gardens in the learn in public philosophy. It is our best shot yet at the final real-world Encyclopedia Galactica by allowing effective mind melding/collective intelligence via the topics feature.
Figure 1.
Logo of the OurBigBook Project
.
OurBigBook CLI quick start using our template project github.com/ourbigbook/template with Node.js installed run:
git clone https://github.com/ourbigbook/template
cd template
npm install
npx ourbigbook .
firefox _out/html/index.html
The HTML output is visible at: ourbigbook.github.io/template
To publish your project as a static website to GitHub Pages, first create a GitHub repository for it, e.g. johnsmith/mybrain and then:
git remote set-url origin git@github.com:ourbigbook/ourbigbook-private.git
ourbigbook --publish
and your project is now published to johnsmith.github.io/template
To publish your project to OurBigBook.com, create an account at ourbigbook.com/go/register and then:
ourbigbook --web
This will ask for your ourbigbook username and password, and then your project will be published at: ourbigbook.com/johnsmith.
A full blown showcase knowledge base can be seen at:
Mission: to live in a world where you can learn university-level mathematics, physics, chemistry, biology and engineering from perfect free open source books that anyone can write to get famous.
Ultimate goal: destroy the currently grossly inefficient education system and replace it with a much more inspiring system where people learn what they want as fast as possible to reach their goals faster without so much useless pain.
How to get there: create a website (live at OurBigBook.com) that incentivizes learners (notably university students taking courses) to write freely licensed university-level natural science books in their own words for free. Their motivation for doing that are:
  • getting their knowledge globally recognized and thus better jobs
  • improving the world
  • learning by teaching
Video 1.
Introduction to the OurBigBook Project
. Source.
Notable features:
  1. topics: groups the articles of different users about the same topic, sorted by upvote to achieve mind melding/collective intelligence. This makes your articles easier for others to find.
    Figure 2.
    The topics feature allows you to find the best version of a subject written by other users user
    . Live demo: derivative.
    Video 2.
    OurBigBook Web topics demo
    . Source.
  2. local editing: you can store all your personal knowledge base content locally in a plaintext markup format that can be edited locally and published with OurBigBook CLI to either:
    This way you can be sure that even if OurBigBook.com were to go down one day (which we have no plans to as it is quite cheap to host!), your content will still be perfectly readable as a static site.
    Figure 3.
    With OurBigBook you can publish local lightweight markup files to either OurBigBook Web or as a static website
    . For example, both of the following pages:
    are generated from the exact same source code at: github.com/cirosantilli/cirosantilli.github.io.
    Figure 4.
    Visual Studio Code extension tree navigation
    .
    Figure 5.
    Web editor
    . You can also edit articles on the Web editor without installing anything locally.
    Video 3.
    Edit locally and publish demo
    . Source. This shows editing OurBigBook Markup and publishing it using the VS Code extension.
    Video 4.
    OurBigBook Visual Studio Code extension
    . Source.
  3. Figure 6.
    Internal cross file reference
    .
    OurBigBook supports internal cross file references to clean IDs that don't depend on either:
    For example, in this screenshot, we are able to link simply from the file:
    quantum-mechanics.bigb
    with:
    <Hilbert space>
    to the header:
    = Hilbert space
    present in another file:
    calculus.bigb
    without specifying:
    • the source code path calculus.bigb
    • the full tree position: Mathematics > Area of mathematics > Calculus > Hilbert space
    This means that you can freely change the location of headers or the tree structure and your links will still work.
    OurBigBook also automatically checks for broken links every time you build, so you will never have a broken link again.
    Live output URLs:
  4. infinitely deep table of contents: never again be limited to only 6 levels of HTML h6 legacy limitations! With OurBigBook, the sky is the limit!
    Furthermore, with our dynamic article tree of OurBigBook Web, every header can be the toplevel header for better SEO and user experience e.g. both the following pages show all their ancestors:
    Figure 7.
    Dynamic article tree with infinitely deep table of contents
    .
    Live URL: ourbigbook.com/cirosantilli/chordate
    Descendant pages can also show up as toplevel e.g.: ourbigbook.com/cirosantilli/chordate-subclade
    Figure 8.
    And this is how the same article looks on the static website
    . Live URL: cirosantilli.com/taxonomy#chordate
Figure 9.
OurBigBook GitHub repository
. Source. Everything that the OurBigBook Project does is open source.
Key links:

Synonyms (2)