X-Git-Url: https://git.r.bdr.sh/rbdr/r.bdr.sh/blobdiff_plain/6626b64f0d1d643b170384f6eed8b97704f43338..edd6210a929b79966acb780247702b118c57c349:/blog.gmi?ds=inline diff --git a/blog.gmi b/blog.gmi index dce90df..6a3d0eb 100644 --- a/blog.gmi +++ b/blog.gmi @@ -4,8 +4,8 @@ Command line tool to author and manage a semi-ephemeral™ blog with a gemini archive. -=> https://git.r.bdr.sh/rbdr/blog view source @ git.r.bdr.sh -=> https://git.sr.ht/~rbdr/blog source mirror @ sourcehut +=> https://git.r.bdr.sh/rbdr/blog ⧇ source +=> https://git.sr.ht/~rbdr/blog ⧉ mirror ## Install @@ -18,6 +18,19 @@ You can install using homebrew. % brew install rbdr/apps/blog ``` +### Prebuilt Packages +You can find pre-built packages for linux @ build.r.bdr.sh. There you can +find a `.tar.gz` that includes only the binary, or `.rpm` and `.deb` +distributions for fedora and debian that include a manpage. + +Binaries are provided for x86_64 and aarch64. + +Unstable releases are built directly from the main branch, while tagged +versions have their own release and can be considered more stable. + +=> gemini://build.r.bdr.sh/blog blog pre-built releases @ gemini +=> https://build.r.bdr.sh/blog blog pre-built releases @ https + ### From Source Make sure you have rust and Make installed. Clone the repository, and run: @@ -63,7 +76,7 @@ Adding and updating posts regenerates the blog and archive, but you can always r blog generate ``` -## Usage II: Publishing +## II: Publishing Publishing the blog and archive requires `rsync`. @@ -87,7 +100,7 @@ blog publish-archive This will include *all the posts* in gemtext format. -## Usage III: Source Control +## III: Source Control Blog supports saving snapshots of the blog in git, and you can add and remove remotes with the following commands: @@ -107,7 +120,7 @@ The blog will always sync down before adding to avoid going out of sync. **IF YOU CHANGE ANY FILES MANUALLY, REMEMBER TO SYNC UP, OTHERWISE YOUR CHANGES WILL BE LOST** -## Usage IV: Customizing +## IV: Customizing The default templates included in blog are very generic and likely not helpful for your use case. However, you can customize this freely: @@ -176,7 +189,7 @@ Finally, you can do conditionals. To negate a conditional you can prepend !. Any files inside the `static` directory of your blog data root (`$XDG_DATA_HOME/blog`) will be copied as is. This is useful for any images, javascript files or stylesheets that you use in your posts or templates. -## Usage V: Where is Data Stored? +## V: Where is Data Stored? Blog uses three diretories to store data, all of them using the XDG User Directories. @@ -189,7 +202,7 @@ Directories. All of these can be overridden by environment variables. -## Usage VI: Configuration +## VI: Configuration You can control the number of posts in the ephemeral blog, and the location of all the data by using environment variables. @@ -218,6 +231,7 @@ The default is `$XDG_CACHE_HOME/blog`. ## Changelog +* 7.0.0 Rewritten in rust, supports gopher (geomyidae format). * 6.0.0 Use custom templates, use XDG directories. => ./blog_6.0.0.gmi Deprecated documentation for blog 6.0.0