💾 Archived View for gmi.noulin.net › markdown › forb_README.md captured on 2023-07-10 at 18:18:02.

-=-=-=-=-=-=-

# Getting started with forb

Forb is a blogging system using configurations similar to [jekyll](https://jekyllrb.com).

- Run `forb new` to copy the default template to the current directory
- Run `forb` to generate the site in the `_site` directory

The source code is available at [forb git](https://noulin.net/forb/file/README.md.html)

# Install

Forb is built with [sheepy](https://spartatek.se/r/sheepy), so it needs to be installed first.

Then run:

  spm -g install forb

# Configuration

The site configuration is located in `_config.yml`. The default `_config.yml` is created in the directory where `forb new` was executed.

# Posts

To create a post, run:

forb new post title


`forb new title` creates a post template in _draft, edit the draft and when ready, run:

forb publish _draft/title.markdown


# Update already published post

To generate the blog, run `forb`, after this the posts are moved from the _posts directory to the _published directory.

To update a post, edit the text in the _published directory, then run:

forb update _published/title.markdown

generate

forb


# About markdown

The markdown standard in forb is `CommonMark` with tables.

- Table example:

| Line 1, Column A - Title line in Bold | Column B - Title line in Bold |

| Line 2, A | 2B |


- Link to external page:

(title)[url]


- Image in post:

!(title)[%baseurl/images/img.png]

When baseurl="/blog", write:

!(title)[/blog/images/img.png]


- Link to another post in blog:

[another post](_%baseurl{% post_url POST_FILENAME_WITHOUT_MARKDOWN_EXTENSION %})

Keep "_%baseurl", forb replaces it with the value in _config.yml,

after post_url write the post filename to be linked without ".markdown":

[another post](_%baseurl{% post_url 2020-06-09-getting-started %})