README.md (1811B)
1 # Getting started with forb 2 3 Forb is a blogging system using configurations similar to [jekyll](https://jekyllrb.com). 4 5 - Run `forb new` to copy the default template to the current directory 6 - Run `forb` to generate the site in the `_site` directory 7 8 The source code is available at [forb git](https://noulin.net/forb/file/README.md.html) 9 10 # Install 11 12 Forb is built with [sheepy](https://spartatek.se/r/sheepy), so it needs to be installed first. 13 14 Then run: 15 16 spm -g install forb 17 18 # Configuration 19 20 The site configuration is located in `_config.yml`. The default `_config.yml` is created in the directory where `forb new` was executed. 21 22 # Posts 23 24 To create a post, run: 25 ``` 26 forb new post title 27 ``` 28 29 `forb new title` creates a post template in _draft, edit the draft and when ready, run: 30 ``` 31 forb publish _draft/title.markdown 32 ``` 33 34 # Update already published post 35 36 To generate the blog, run `forb`, after this the posts are moved from the _posts directory to the _published directory. 37 38 To update a post, edit the text in the _published directory, then run: 39 ``` 40 forb update _published/title.markdown 41 # generate 42 forb 43 ``` 44 45 # About markdown 46 47 The markdown standard in forb is `CommonMark` with tables. 48 49 - Table example: 50 ``` 51 | Line 1, Column A - Title line in Bold | Column B - Title line in Bold | 52 | Line 2, A | 2B | 53 54 ``` 55 56 - Link to external page: 57 ``` 58 (title)[url] 59 ``` 60 61 - Image in post: 62 ``` 63 !(title)[%baseurl/images/img.png] 64 65 When baseurl="/blog", write: 66 !(title)[/blog/images/img.png] 67 ``` 68 69 - Link to another post in blog: 70 ``` 71 [another post](_%baseurl{% post_url POST_FILENAME_WITHOUT_MARKDOWN_EXTENSION %}) 72 73 Keep "_%baseurl", forb replaces it with the value in _config.yml, 74 after post_url write the post filename to be linked without ".markdown": 75 [another post](_%baseurl{% post_url 2020-06-09-getting-started %}) 76 ```