Miroirs/noc-book-2
1
0
Fork 0
mirror of https://github.com/nature-of-code/noc-book-2 synced 2024-09-29 05:36:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
Mirror of https://github.com/nature-of-code/noc-book-2
912 commits 23 branches 0 tags 340 MiB
HTML 73.4%
JavaScript 25%
CSS 0.8%
SCSS 0.8%
Find a file
Yifei Gao bfa0d1d62f
Merge pull request #848 from nature-of-code/notion-update-docs 
[Notion] Update docs
2024-02-26 23:29:39 +08:00
.github Update FUNDING.yml 2023-09-10 19:12:04 -04:00
content Notion - Update docs 2024-02-26 15:23:33 +00:00
docs update doc 2023-08-29 23:19:20 +08:00
gatsby add Example endpoint 2024-01-24 14:28:44 +08:00
magicbook change cross reference format 2024-02-26 22:58:23 +08:00
src add /example page and links 2024-01-24 14:58:43 +08:00
tests test update: screenshots dimensions exception list 2023-10-09 10:13:42 -04:00
.gitignore add prince license 2024-01-16 21:38:10 +08:00
.prettierrc Create .prettierrc 2022-04-04 16:40:23 -04:00
gatsby-browser.js add codesplit support 2022-08-17 22:02:53 -04:00
gatsby-config.js change section type name 2024-01-24 14:27:00 +08:00
gatsby-node.js fix copying files from examples 2023-02-26 11:04:37 -05:00
magicbook.json use roman numerals for page references in front matter 2024-02-26 21:42:17 +08:00
package-lock.json update magicbook version 2024-01-16 22:27:28 +08:00
package.json update magicbook version 2024-01-16 22:27:28 +08:00
postcss.config.js add codesplit support 2022-08-17 22:02:53 -04:00
README.md add icon attribution 2023-09-19 23:50:18 +08:00
tailwind.config.js update layout styles / separate components 2022-08-25 15:57:04 -04:00

README.md

The Nature of Code 2nd Edition

This repo contains all the files for the Nature of Code 2nd edition. The book is now being authored in Notion and imported here as raw HTML files (which are then used to build the print PDF and gatsby website).

Data flow chart showing three parts: edit, store, and output.

Edit & Import

Notion Database Screenshot

Content are stored in a Notion Database with the following attributes:

  • Type (Page | Chapter): to be handled differently during builds, now only act in the website build.
  • Title: defines the title
  • Status (Draft | Published): only Published ones will be imported
  • File Name: defines the page sequence in a pdf build
  • Slug: defines the path in web page URL

Each entity also contains a page of its content, which will be transformed to html files based on the schema. The transformation script (nature-of-code/fetch-notion) is written in Node.js, utilized as a GitHub action.

Build

Following are the steps to build the book and website, however, you will have to skip the import-notion-docs as that can only be done with the Notion API key associated with the book. You can find the latest HTML version of the book in /content.

# Install Dependencies
npm install

# Build PDF (Magicbook) in `build` directory
npm run build:pdf

# Build Website in `public` directory
npm run build

Attributions

Icons used in this project:

🖍️ (Crayon) & 🦜 (Parrot) & 🔎 (Magnifying glass) from OpenMoji – CC BY-SA 4.0