conlang.phundrak.com/README.org
Lucien Cartier-Tilet 3feaf8a50a
All checks were successful
continuous-integration/drone/push Build is passing
docs(README): update Emacs version in badge
2023-09-17 15:25:14 +02:00

71 lines
2.9 KiB
Org Mode
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

#+title: Pundraks Conlangs
#+html: <a href="https://www.gnu.org/software/emacs/"><img src="https://img.shields.io/badge/Emacs-29.1-blueviolet.svg?style=flat-square&logo=GNU%20Emacs&logoColor=white" /></a>
#+html: <a href="https://orgmode.org/"><img src="https://img.shields.io/badge/Written%20with-Org%20mode-success?logo=Org&logoColor=white&style=flat-square"/></a>
#+html: <a href="https://v2.vuepress.vuejs.org/"><img src="https://img.shields.io/badge/Framework-Vuepress-42D392?logo=Vue.js&logoColor=white&style=flat-square"/></a>
#+html: <a href="https://conlang.phundrak.com"><img src="https://img.shields.io/badge/dynamic/json?label=Website&query=%24%5B%3A1%5D.status&url=https%3A%2F%2Fdrone.phundrak.com%2Fapi%2Frepos%2Fphundrak%2Fconlang.phundrak.com%2Fbuilds&style=flat-square&logo=buffer" /></a>
* About the Project
This repository holds my conlanging projects I am working on. The
files Im 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