My conlanging website, powered by orgmode and Vuepress! https://conlang.phundrak.com
Go to file
Lucien Cartier-Tilet 96409f3ef7
All checks were successful
deploy / deploy (push) Successful in 2m0s
docs(eittlandic): some more vocabulary
2024-06-30 18:39:58 +02:00
.gitea/workflows chore: switch to node 20 2024-06-23 13:14:42 +02:00
docs docs(eittlandic): some more vocabulary 2024-06-30 18:39:58 +02:00
.envrc chore: upgrade dependencies, switch from yarn to npm 2024-06-21 08:15:31 +02:00
.gitattributes feat: make org files detectable 2024-01-27 19:07:48 +01:00
.gitignore chore: switch from npm to yarn 2024-01-27 15:24:47 +01:00
.volarrc initial commit 2023-02-26 21:01:19 +01:00
.yarnrc.yml chore: standardize yarn commands across my projects 2024-01-28 06:25:58 +01:00
agpl-3.0.md docs: change code license to AGPL-3.0 2023-07-01 23:26:09 +02:00
by-nc-sa.md initial commit 2023-02-26 21:01:19 +01:00
CONTRIBUTING.org initial commit 2023-02-26 21:01:19 +01:00
export.el docs(markdown): don’t add frame attribute to tables 2024-06-21 08:26:56 +02:00
fdl-1.3.md initial commit 2023-02-26 21:01:19 +01:00
LICENSE.org docs: change code license to AGPL-3.0 2023-07-01 23:26:09 +02:00
package-lock.json chore: upgrade dependencies, switch from yarn to npm 2024-06-21 08:15:31 +02:00
package.json chore: upgrade dependencies, switch from yarn to npm 2024-06-21 08:15:31 +02:00
README.org docs(README): update Emacs version in badge 2023-09-17 15:25:14 +02:00
shell.nix chore: switch to node 20 2024-06-23 13:14:42 +02:00

Pundraks Conlangs

About the Project

This repository holds my conlanging projects I am working on. The files Im 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