My conlanging website, powered by orgmode and Vuepress!
https://conlang.phundrak.com
All checks were successful
deploy / deploy (push) Successful in 1m42s
|
||
---|---|---|
.gitea/workflows | ||
docs | ||
.envrc | ||
.gitattributes | ||
.gitignore | ||
.volarrc | ||
.yarnrc.yml | ||
agpl-3.0.md | ||
by-nc-sa.md | ||
CONTRIBUTING.org | ||
export.el | ||
fdl-1.3.md | ||
LICENSE.org | ||
package-lock.json | ||
package.json | ||
README.org | ||
shell.nix |
P’undrak’s Conlangs
About the Project
This repository holds my conlanging projects I am working on. The files I’m using are written in org-mode and are exported in Markdown through Emacs.
These Markdown files are then compiled by Vuepress into a beautiful website available at conlang.phundrak.com.
Running the project
In order to run the project, you need to export all .org
files in the
Markdown format. To do that easily, you can use an org project setup
in Emacs, mine looks like this:
(require 'ox-gfm)
(defvar phundrak--projects-conlanging-common-root
"~/org/conlanging/docs/"
"Points to the common root of my source and target for my
conlang.phundrak.com org project.")
(setq org-publish-project-alist
`(("conlang-phundrak-com-md"
:base-directory ,phundrak--projects-conlanging-common-root
:base-extension "org"
:exclude ,(rx (* print
(or "CONTRIB"
"README"
"site-map"
"temp"
"private"
"svg-ink")
(* print)))
:publishing-directory ,phundrak--projects-conlanging-common-root
:recursive t
:language "en"
:publishing-function org-gfm-publish-to-gfm
:headline-levels 5
:auto-sitemap nil
:auto-preamble nil)
("conlang-phundrak-com"
:components ("conlang-phundrak-com-md"))))
Once you have all the Markdown files generated correctly, you can install the dependencies of the project.
yarn
# or
npm install # delete the yarn.lock file first
Once this is done, you can launch a preview of the project.
yarn docs:dev
# or
npm run docs:dev
You can also compile the project to a static website.
yarn docs:build
# or
npm run docs:build