Code Monkey home page Code Monkey logo

braindump's Introduction

Netlify Status

Braindump

Host org notes online.

Requirements

Ninja spawns many Emacs instances in batch mode running ox-hugo, parallelizing the job of exporting the Org files.

Convert Org to Markdown

build.py will convert all Org files in the same level org dir into Markdown. Change org dir path in build.py.

# steps of build.py
1. find org files
2. ignore excluded files
3. write file list into build.ninja
4. call ninja

To convert all Org files into Markdown, run:

python3 ./build.py

Exclude / Include List

Create files excludelist or includelist and put patterns into them, one per line. build.py will use relative file paths to match the patterns (e.g. org/test.org).

Hugo Part

Once the Markdown files are generated, we can use Hugo to generate the website.

Install hugo. E.g., on a Mac with Homebrew:

$ brew install hugo

Make sure the submodule containing the Hugo theme is installed:

$ git submodule init
$ git submodule update

Now run hugo to generate the files (find them in /public):

$ hugo

Or run the following to get an immediately browsable website on localhost:

$ hugo serve

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.