Skip to content

Mayukhdeb/writing

Repository files navigation

Writing

This repo is inspired by goodresearch.dev. It also depends on a fork of the sphinx-book-theme. You'd have to make changes to that repo if you want to fix the metadata for link previews.

Setup

Recreate the conda environment with:

conda env create -n cb --file environment.yml

Build website

conda activate cb && rm -rf docs/* && jupyter-book build source && cp -r source/_build/html/* docs/ && touch docs/.nojekyll && rm -rf source/_build

This builds from source/ and outputs HTML to docs/ for GitHub Pages.

Adding a new post

  1. Create a new markdown file in source/ (e.g., source/my-new-post.md)
  2. Add it to source/_toc.yml under the Posts section:
- caption: Posts
  chapters:
    - file: zipf
    - file: my-new-post

Experimental: WYSIWYG editor

python3 editor/server.py

About

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors