Miroirs/noc-book-2
1
0
Fork 0
mirror of https://github.com/nature-of-code/noc-book-2 synced 2024-11-17 07:49:05 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
Mirror of https://github.com/nature-of-code/noc-book-2
272 commits 36 branches 0 tags 342 MiB
HTML 72.8%
JavaScript 25.6%
CSS 0.8%
SCSS 0.8%
Find a file
shiffman 5101bb792f Notion - Update docs
2023-03-20 20:19:58 +00:00
.github/workflows Update notion-git.yml 2023-02-26 10:09:00 -05:00
content Notion - Update docs 2023-03-20 20:19:58 +00:00
docs update test and docs 2022-11-28 10:17:14 -05:00
gatsby support pdf-only and web-only blocks 2022-11-28 11:25:59 -05:00
magicbook quick fix of a sass warning 2023-03-01 20:32:44 -05:00
src improve embed layout with narrow width 2023-03-02 11:39:32 -05:00
.gitignore add test 2022-09-30 15:33:25 -04: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 add local images handling in gatsby 2022-07-28 21:29:28 -04:00
gatsby-node.js fix copying files from examples 2023-02-26 11:04:37 -05:00
magicbook.json increase pdf build timeout 2023-03-14 22:17:59 -04:00
package-lock.json remove previous scripts and dependencies 2023-02-26 11:04:09 -05:00
package.json remove previous scripts and dependencies 2023-02-26 11:04:09 -05:00
postcss.config.js add codesplit support 2022-08-17 22:02:53 -04:00
README.md Update README.md 2023-03-02 21:42:56 -05: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