https://github.com/phundrak/conlang.phundrak.com

My conlanging website, powered by orgmode and Vuepress. Mirror of https://labs.phundrak.com/phundrak/conlang.phundrak.com
https://github.com/phundrak/conlang.phundrak.com

conlang conlanging emacs org-mode vue vuejs vuepress

Last synced: 2 months ago
JSON representation

My conlanging website, powered by orgmode and Vuepress. Mirror of https://labs.phundrak.com/phundrak/conlang.phundrak.com

• Host: GitHub
• URL: https://github.com/phundrak/conlang.phundrak.com
• Owner: Phundrak
• License: other
• Created: 2023-02-26T22:08:44.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-01-19T16:41:36.000Z (4 months ago)
• Last Synced: 2025-02-04T19:38:48.642Z (4 months ago)
• Topics: conlang, conlanging, emacs, org-mode, vue, vuejs, vuepress
• Language: Org
• Homepage: https://conlang.phundrak.com
• Size: 22.7 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.org
  • Contributing: CONTRIBUTING.org
  • License: LICENSE.org

Awesome Lists containing this project

README

        
#+title: P’undrak’s Conlangs

#+html: 

#+html: 

#+html: 

#+html: 

* About the Project

This repository holds my conlanging projects I am working on. The

files I’m using are written in [[https://orgmode.org/][org-mode]] and are exported in Markdown

through [[https://www.gnu.org/software/emacs/][Emacs]].

These Markdown files are then compiled by [[https://v2.vuepress.vuejs.org/][Vuepress]] into a beautiful

website available at [[https://conlang.phundrak.com][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:

#+begin_src emacs-lisp

(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"))))

#+end_src

Once you have all the Markdown files generated correctly, you can

install the dependencies of the project.

#+begin_src shell

yarn

# or

npm install # delete the yarn.lock file first

#+end_src

Once this is done, you can launch a preview of the project.

#+begin_src shell

yarn docs:dev

# or

npm run docs:dev

#+end_src

You can also compile the project to a static website.

#+begin_src shell

yarn docs:build

# or

npm run docs:build

#+end_src