Giter VIP home page Giter VIP logo

braindump's Introduction

Netlify Status

Eigil's Braindump

Adapted from Jethro's Braindump

This braindump is generated via ox-hugo and uses the cortex theme.

To use this version of the script, modify build.py, pointing it at your folder of org-files. You also need a export-to-markdown setup in your emacs config. Here is mine:

(defun ayegill/braindump-file (file)
  (remove-hook! 'find-file-hook #'+org-roam-open-buffer-maybe-h)
  (with-current-buffer (find-file-noselect file)
  (projectile-mode -1)
  (dtrt-indent-mode -1)
  (let ((org-id-extra-files (find-lisp-find-files org-roam-directory "\.org$"))
        (org-hugo-base-dir "~/projects/braindump"))
    (org-hugo-export-wim-to-md))))

Installation instructions

I use the 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:

./build.py

to generate the build instructions. build.py is simple enough to inspect.

Then run ninja to run the build.

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

Common issues

  • If some of your org-files contain colons, hugo will choke on the links. There's no way around this execpt to rename your files. To assist this, build.py automatically skips files containing colons, and prints a list of them.
  • If some of your files contain org-hugo instructions, it will get confused.
  • I've inserted a dummy "Blog Posts" file because I had a file that broke the script a lot

braindump's People

Contributors

jethrokuan avatar dependabot-preview[bot] avatar ayegill avatar hraban avatar dependabot[bot] avatar

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.