phundrak.com/README.org

phundrak.com

• Introduction
• Structure of the project
  • Installing and running

Introduction

This is the repository for my website phundrak.com. While it is not yet live on this address, development versions can be found at alpha.phundrak.com and beta.phundrak.com (the former follows the develop branch while the latter follows the master branch).

Structure of the project

This website is made with VuePress, a Vue-powered static site generator. You can find its Node.JS configuration in the package.json file as well as its content and general configuration in the directory content.

Installing and running

In order to run the website, you firts need to export all the orgmode files to Markdown files. I recommend using ox-gfm to do so. If you don’t mind package.el installing it as well as f.el, you can run the following command:

emacs -Q --script export.el

To install the NPM dependencies for the project, run one of the following commands:

yarn
# or
npm install # delete the yarn.lock file before

To run the project, run one of the following commands using the same package manager as above:

yarn dev
# or
npm run dev

You can compile the website to a static website by running

yarn build
# or
npm run build

The compiled version of the website can then be found in content/.vuepress/dist.