https://github.com/jethrokuan/braindump

knowledge repository managed with org-mode and org-roam.
https://github.com/jethrokuan/braindump

notes org-mode

Last synced: 29 days ago
JSON representation

knowledge repository managed with org-mode and org-roam.

• Host: GitHub
• URL: https://github.com/jethrokuan/braindump
• Owner: jethrokuan
• Created: 2017-03-02T14:55:34.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-02T08:22:52.000Z (almost 2 years ago)
• Last Synced: 2024-08-05T20:31:48.284Z (3 months ago)
• Topics: notes, org-mode
• Language: TeX
• Homepage: https://braindump.jethro.dev/
• Size: 34.7 MB
• Stars: 379
• Watchers: 19
• Forks: 85
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Netlify Status](https://api.netlify.com/api/v1/badges/d6b49afd-cd07-4714-87d1-bc8e8239068f/deploy-status)](https://app.netlify.com/sites/braindump-jethrokuan/deploys)

# Jethro's Braindump

This braindump is generated via [ox-hugo][ox-hugo] and uses the

[cortex][cortex] theme.

The org files used to generate the markdown files are also hosted here

for posterity. They can be found in [the org folder][org].

## Installation instructions

I use the [Ninja](https://ninja-build.org/ "Ninja") build tool to convert my Org

files into Markdown locally. This is so that only changed Org files get

reprocessed into Markdown files. Ninja spawns many Emacs instances in batch mode

running `ox-hugo`, parallelizing the job of exporting the Org files.

To convert all Org files into Markdown, run:

```bash

./build.py

```

`build.py` is simple enough to inspect. Once the Markdown files are generated,

we can use Hugo to generate the website.

Install [hugo][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

[hugo]: https://gohugo.io/

[ox-hugo]: https://github.com/kaushalmodi/ox-hugo

[cortex]: https://github.com/jethrokuan/cortex

[org]: https://github.com/jethrokuan/braindump/tree/master/org