Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 1.65 KB

README.org

File metadata and controls

55 lines (39 loc) · 1.65 KB

The notes and articles directories contain org documents.

The docs directory contains generated HTML. The directory is called docs because GitHub pages can only be configured to serve from a subdirectory if it is called ”docs”.

Dependencies

  • sass CLI
    • MacOS: brew install sass/sass/sass
    • npm: npm install -g sass

Directories

  • articles/: Org files.
  • notes/: Org files.
  • static/: Top-level static assets (currently just a SCSS file).
  • docs/: Generated HTML files. GitHub Pages requires this directory to be called “docs”.

Local Server

In the docs directory: use a program like serve (serve .) or python -m http.server for viewing the site locally (which makes relative links work correctly).

Notes / TODO

  • [ ] Create build script
  • [ ] Live reload HTML if I start an Emacs web server
  • [ ] Exclude README.org from HTML export
  • [ ] Layouts: One for index pages, one for content pages

Structure and Content

  • [ ] Persistent links to sections
  • [ ] Remove “home” from links on sitemap pages.
  • [ ] Move html-head to file
  • [ ] Content Pages: Move TOC to right side

Themes?

Move personal SCSS to a themes directory. Each theme can (and probably should) @import the base CSS that org-mode generates.

  • [ ] Hamburger menu on smaller screens
  • [ ] Favicon

Resources