Allow showing article body on article lists
OurBigBook.com: the best way to publish your scientific knowledge.
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.
OurBigBook CLI quick start using our template project github.com/ourbigbook/template with Node.js installed run:The HTML output is visible at: ourbigbook.github.io/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
To publish your project as a static website to GitHub Pages, first create a GitHub repository for it, e.g. and your project is now published to johnsmith.github.io/template
johnsmith/mybrain
and then:git remote set-url origin git@github.com:ourbigbook/ourbigbook-private.git
ourbigbook --publish
To publish your project to OurBigBook.com, create an account at ourbigbook.com/go/register and then:This will ask for your ourbigbook username and password, and then your project will be published at: ourbigbook.com/johnsmith.
ourbigbook --web
A full blown showcase knowledge base can be seen at:
- cirosantilli.com (static website publish)
- ourbigbook.com/cirosantilli (equivalent on OurBigBook.com with dynamic website features such as topics)
- github.com/cirosantilli/cirosantilli.github.io (source code for both of the above)
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
Introduction to the OurBigBook Project
. Source. Notable features:
- 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. - 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.
- to OurBigBook.com: to get awesome multi-user features like OurBigBook Web topics
- as HTML files to a static website: you can host yourself for free on many external providers like GitHub Pages, and remain in full control
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.- cirosantilli.com (static)
- ourbigbook.com/cirosantilli (dynamic)
Figure 4. Visual Studio Code extension tree navigation.Figure 5. . You can also edit articles on the Web editor without installing anything locally. Figure 6. Creating a new article on the web editor.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. Figure 7. . OurBigBook supports internal links to clean IDs that don't depend on either:For example, in this screenshot, we are able to link simply from the file:- source code file paths
- table of contents tree position
with:quantum-mechanics.bigb
to the header:<Hilbert space>
present in another file:= Hilbert space
without specifying:calculus.bigb
This means that you can freely change the location of headers or the tree structure and your links will still work.- the source code path
calculus.bigb
- the full tree position:
Mathematics
>Area of mathematic
s >Calculus
>Hilbert space
OurBigBook also automatically checks for broken links every time you build, so you will never have a broken link again.Figure 8. Non-toplevel tagged headers demo.Visible live at: cirosantilli.com/film#documentary-filmWith OurBigBook, tags are just headers.This allows you to add arbitrary comments to your tags explaining them as the need arises.- 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 10. Dynamic article tree with infinitely deep table of contents.Live URL: ourbigbook.com/cirosantilli/chordateDescendant pages can also show up as toplevel e.g.: ourbigbook.com/cirosantilli/chordate-subcladeFigure 11. And this is how the same article looks on the static website. Live URL: cirosantilli.com/taxonomy#chordate Figure 12. . Search for your and other people's articles.Visible live at: ourbigbook.com/go/articles?body=false&search=physics-and- Every single section has a clear and sane discussion area, where you can easily ask the author for clarifications and corrections, and where other readers can find answers to their problems in older existing discussions.
Figure 13. OurBigBook Web discussion links from the section headers. Every section has a "Discussions" button where URL: ourbigbook.com/barack-obama/integral#fundamental-theorem-of-calculusFigure 14. OurBigBook Web discussion list for a given article. We can then list all the existing discussions for a given header. URL: ourbigbook.com/go/discussions/barack-obama/fundamental-theorem-of-calculusFigure 15. OurBigBook Web discussion example. This is how a specific discussion looks like. URL: ourbigbook.com/go/discussion/1/barack-obama/fundamental-theorem-of-calculus
OurBigBook GitHub repository
. Source. Everything that the OurBigBook Project does is open source.Key links:
- OurBigBook.com: reference OurBigBook Web instance
- donate to the OurBigBook Project: donate
- project announcements: Section "News". Also posted in shorter form to Section "Official accounts" such as:
- cirosantilli.com/ourbigbook-com: further rationale behind the project by the founder Ciro Santilli
- cirosantilli.com: showcase static demo document with interesting content, published with OurBigBook CLI. Primary inspiration for OurBigBook development.
- cirosantilli.com/oxford-nanopore-river-bacteria: a self-contained tutorial style part of the above. Note how internal links integrate seamlessly into the more global topic of biology, e.g. when talking about DNA we link to the global topic cirosantilli.com/dna.
- github.com/cirosantilli/cirosantilli.github.io and github.com/cirosantilli/cirosantilli.github.io/blob/dev/oxford-nanopore-river-bacteria.bigb: source of the above showcase documents
- Section "Design goals": OurBigBook Markup and OurBigBook CLI feature overview
- github.com/ourbigbook/ourbigbook: OurBigBook source code
- github.com/ourbigbook/ourbigbook/issues: project issue tracker
- github.com/ourbigbook/ourbigbook/blob/master/index.bigb: source for this document
- docs.ourbigbook.com: rendered version of this document
- docs.ourbigbook.com/_obb/dist/editor: live in-browser editor demo
- github.com/ourbigbook/template: good template to get started with OurBigBook CLI, see Section "OurBigBook CLI quick start"
- cirosantilli.com/ourbigbook-media: media for the project such as for documentation and publicity, more info: Section "OurBigBook media repository"