https://github.com/ashdeclerk/staticsitegenerator

A static site generator, made as part of the Boot.dev curriculum.

https://github.com/ashdeclerk/staticsitegenerator

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (5.6%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

A static site generator, made as part of the Boot.dev curriculum.

Basic Info
  • Host: GitHub
  • Owner: ashdeclerk
  • Language: Python
  • Default Branch: main
  • Size: 4.71 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created about 1 year ago · Last pushed about 1 year ago
Metadata Files
Readme

README.md

Static Site Generator

This static site generator was made as part of the Boot.dev curriculum.

Start with markdown files in the /content directory. Then run build.sh, which will delete everything in /docs and replace it with an HTML-ified version of those markdown files. You can then push the contents of /docs to a site hosting service.

Note that main.sh will build the site and run a local server, which is useful for previewing stuff (by opening up localhost:8888 with the server running).

DO NOT STORE ANYTHING IN /docs THAT YOU DON'T WANT DELETED!

How it works

The rough outline is: 1. Delete everything in /docs. 2. Copy static assets from /static to /docs. 3. Convert each block of text from markdown files in /content to a tree of HTMLNode objects. 4. Join all of the HTMLNode blocks under a single parent for each page. 5. Convert said HTMLNode to an HTML string and inject it in the template. 6. Write that string to a file in /docs.

Future plans

  • Add support for tables
  • Add support for checkboxes (non-functional, but good for displaying stuff)

Owner

  • Login: ashdeclerk
  • Kind: user

GitHub Events

Total
  • Push event: 3
  • Create event: 2
Last Year
  • Push event: 3
  • Create event: 2