1
0
Fork
You've already forked gemwriter
0
Helper for publishing Gemini capsules
  • Nim 99%
  • Makefile 1%
mio 7d303514bd Add date for posts in index page generation 
- Add date for posts in the index page for them to be compatible with
 Gemini Subscription
- Adjust tests
2024年02月29日 23:46:04 +00:00
langs Bugfixes 2023年10月08日 02:17:02 +00:00
templates Add support for customised page templates 2023年10月05日 03:19:18 +00:00
tests Add date for posts in index page generation 2024年02月29日 23:46:04 +00:00
.gitignore Bugfixes 2023年10月08日 02:17:02 +00:00
gemwriter.nim Add date for posts in index page generation 2024年02月29日 23:46:04 +00:00
gw.nim Add tests 2023年10月07日 04:25:34 +00:00
Makefile Bugfixes 2023年10月08日 02:17:02 +00:00
readme.md Bugfixes 2023年10月08日 02:17:02 +00:00
translations.nim Bugfixes 2023年10月08日 02:17:02 +00:00

Gemwriter

A little command-line helper for publishing Gemini capsules or sites.

Features

  • Add and list capsules
  • Add new pages or gemlog posts
  • Generate an index page and Atom feed
  • Publish with a custom terminal command (e.g. via scp, rsync)

Requirements

  • Linux or Unix-based OS
  • Nim 2.0.0+
  • A file transfer application such as scp or rsync if publishing to a remote server

Build and install

  1. Get Nim from the official website or system distribution repos. Optionally install make.

  2. Download and extract the source archive. Change into the source directory and run make to build the executable. (If not using make, run this command to build: nim c -d:release gw.nim)

  3. Run make install with superuser privileges or move the gw executable to a location in your $PATH.

Quick start

  1. Run gw list to see a list of capsules, which will also create a configuration file when run for the first time.

  2. Edit ~/.config/gemwriter/config.json with details about your capsule or gemlog.

  3. Create a new page: gw page [capsule] "Hello World!"

  4. Publish your capsule: gw publish [capsule]

You can also type gw help for a list of available options.

Contributing translations

  1. Copy langs/en.json and rename the copy as langs/[lang].json, where [lang] is the ISO-639-1 language code for the target language, e.g. ja for Japanese.

  2. Add the language under the langs variable in translations.nim.

  3. Open a PR with the changes.

License

BSD-3-Clause