phundrak/config.phundrak.com
1
0
Fork 0
Code Issues Pull Requests Actions Activity
My dotfiles in a literate config style https://config.phundrak.com
1,788 Commits 1 Branch 0 Tags 29 MiB
Org 99.4%
Emacs Lisp 0.5%
f7b6ef1a4c
Go to file
Lucien Cartier-Tilet f7b6ef1a4c
docs(hyprland, scripts): better screenshot script 
This commit adds the possibility of using swappy to edit screenshots.
It also changes the behaviour of the delay by first allowing the user
to select the area they want to capture, and then only does it wait
for the indicated amount of time before it takes the screen capture.
2024-04-03 06:03:17 +02:00
.gitea/workflows chore(deps): update Vuepress 2024-01-28 05:39:54 +01:00
docs docs(hyprland, scripts): better screenshot script 2024-04-03 06:03:17 +02:00
.gitattributes feat: try to fix detection of org docs 2024-01-27 19:06:13 +01:00
.gitignore chore(deps): update Vuepress 2024-01-28 05:39:54 +01:00
.prettierrc.json style: reformat ts files 2024-01-28 05:30:15 +01:00
.volarrc [Misc] switching to new repo for org files 2023-09-18 20:12:17 +02:00
.yarnrc.yml chore(deps): update Vuepress 2024-01-28 05:39:54 +01:00
agpl-3.0.md [Misc] switching to new repo for org files 2023-09-18 20:12:17 +02:00
by-nc-sa.md [Misc] switching to new repo for org files 2023-09-18 20:12:17 +02:00
export.el [Misc] switching to new repo for org files 2023-09-18 20:12:17 +02:00
fdl-1.3.md [Misc] switching to new repo for org files 2023-09-18 20:12:17 +02:00
LICENSE.org [Misc] switching to new repo for org files 2023-09-18 20:12:17 +02:00
package.json chore: update version of yarn used 2024-04-01 06:46:27 +02:00
README.org chore,docs: add Nix shell, update readme accordingly 2024-04-01 06:48:58 +02:00
shell.nix chore,docs: add Nix shell, update readme accordingly 2024-04-01 06:48:58 +02:00
yarn.lock chore: update yarn lockfile 2024-04-02 05:39:01 +02:00

README.org

P’undrak’s dotfiles

About the Project

This repository holds my Linux dotfiles and other configuration files. The files I’m using are written in org-mode and exported in Markdown through Emacs.

These Markdown files are then compiled by Vuepress into a beautiful website available at config.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-config-common-root
  "~/org/config/docs/"
  "Points to the common root of my source and target for my
config.phundrak.com org project.")
(setq org-publish-project-alist
        `(("config-phundrak-com-md"
           :base-directory ,phundrak--projects-config-common-root
           :base-extension "org"
           :exclude ,(rx (* print
                            (or "CONTRIB"
                                   "README"
                                   "site-map"
                                   "temp"
                                   "private"
                                   "svg-ink")
                            (* print)))
           :publishing-directory ,phundrak--projects-config-common-root
           :recursive t
           :language "en"
           :publishing-function org-gfm-publish-to-gfm
           :headline-levels 5
           :auto-sitemap nil
           :auto-preamble nil)
          ("config-phundrak-com"
           :components ("config-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 dev
# or
npm run dev

You can also compile the project to a static website.

yarn build
# or
npm run build

With Nix shell

A Nix shell is available for running the project without the Emacs part. Simply run nix-shell in the project root. You’ll get the latest version of yarn installed and should be able to run the commands above.