Repository for my main website https://phundrak.com
Go to file
Lucien Cartier-Tilet c19d847686
chore: add gitattributes file for orgmode detection in languages of project
2023-11-03 19:48:39 +01:00
content refactor: simplify code head generation 2023-11-03 19:48:39 +01:00
.drone.yml chore: update CI 2023-11-03 19:48:34 +01:00
.editorconfig feat: add bases for GitHub API interaction and cache 2023-05-04 23:23:01 +02:00
.gitattributes chore: add gitattributes file for orgmode detection in languages of project 2023-11-03 19:48:39 +01:00
.gitignore docs: switch from Markdown to orgmode 2023-05-11 00:19:47 +02:00
.volarrc chore(docs): hint lsp-mode to use vue-semantic-server a.k.a volar 2023-02-27 22:48:52 +01:00
LICENSE.md feat(backend): add initial backend 2023-02-09 12:13:51 +01:00
README.org docs: update README instructions 2023-11-03 19:48:39 +01:00
cliff.toml chore(frontend): add git-cliff for generating changelog 2023-02-09 13:21:51 +01:00
export.el chore: update CI 2023-11-03 19:48:34 +01:00
package.json feat: properly display GitHub repositories 2023-05-05 00:42:11 +02:00
yarn.lock feat: properly display GitHub repositories 2023-05-05 00:42:11 +02:00

README.org

phundrak.com

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 dont 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.