Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/olaven/markblog
The way to blog with markdown.
https://github.com/olaven/markblog
blog blog-engine deno markdown rss
Last synced: 5 days ago
JSON representation
The way to blog with markdown.
- Host: GitHub
- URL: https://github.com/olaven/markblog
- Owner: olaven
- License: gpl-3.0
- Created: 2019-01-01T22:34:50.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-10-15T09:00:22.000Z (about 2 years ago)
- Last Synced: 2024-12-09T16:51:12.399Z (14 days ago)
- Topics: blog, blog-engine, deno, markdown, rss
- Language: TypeScript
- Homepage:
- Size: 228 KB
- Stars: 16
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
 [](https://codebeat.co/projects/github-com-olaven-markblog-master)
# Markblog
The way to blog with markdown.
If you or your company is benefitting from Markblog, consider becoming a [sponsor](https://github.com/sponsors/olaven/).
This way I can work on new features and continue to maintain it worry-free.
- [Markblog](#markblog)
- [About](#about)
- [Installation](#installation)
- [Getting started](#getting-started)
- [Contributions](#contributions)
- [Versions](#versions)
- [Documentation](#documentation)
- [Commands](#commands)
- [RSS](#rss)
- [Options](#options)
## About
Markblog is a small `cli` that converts markdown files into a lightweight blog.
It is not tied to any platform, and you own your files. In other words, you are the only one owning your content.
Markblog aims to be easy to use and uncomplicated.
## Installation
* Install [deno](https://deno.land)
* `deno install --allow-read --allow-write --unstable --allow-run --name markblog https://raw.githubusercontent.com/olaven/markblog/master/mod.ts`
* Grab the location path at end of logging
* Update your path: `export PATH=":$PATH"`
## Getting started
* Run `markblog init` in an empty folder.
* Write posts in the generated `./posts`, in `.md`-files.
* Run `markblog build` to build pages.
See [this guide](https://olaven.org/out/guides/blog_with_git_and_markdown.html) for a git/CI-integrated setup.
This is, of course, just one of the many ways you could use Markblog.
## Contributions
All kinds of contributions are welcome.
Feature requests, bug reports, code,
artwork, documentation, or just feedback in general.
Do not hesitate to [post an issue](https://github.com/olaven/markblog/issues/new) :honey_pot:
## Versions
Versions are managed using [Deno's version tool](https://deno.land/x/[email protected]).
To update, use `version patch`, `version minor` or `version major` according to [semver](https://semver.org/).
This updates the `VERSION` file and creates a git tag for the version.
## Documentation
### Commands
* `markblog init` will set up everything (AKA 1 file and 1 folder 😅)
* (_optional_) pass [options](#options) customize. Make sure to use the same options when building!
* `markblog build` actually builds your webpage.
* (_optional_) pass [options](#options) customize.
* `markblog help` if you are stuck
### RSS
Markblog automatically generates an rss-feed, `feed.xml` if `rss_options` is specified
in the options file. See the RSS-option under [options](#options) for more details.
### Options
Options enable you to specify where Markblog should look for files
when generating your blog. There are default settings, and specifying
custom options can be emitted entirely. If however, you want to use custom options, provide `./options.json` at the
root of your blog directory. If you want options in a custom location, use
`--options`-flag, like: `--options path/to/options.json`.
As an example, custom location of posts _and_ custom stylesheet for posts would look
something like this:
```json
{
"post_source": "./path/to/posts",
"post_style": "./path/to/custom/style.css",
}
```
* Title of blog
* `blog_title`
* Title of the page, displayed in the browser tab
* "Blog" by default
* Source of posts
* `post_source`
* the directory where Markblog will search for blog-posts
* `./posts` by default
* Destination of posts
* `post_destination`
* The Directory where posts will go after building
* `./out` by default
* CSS stylesheet of posts
* `post_style`
* The location of stylesheet for the posts, relative to `post_destination`
* `../style.css` by default
* CSS stylesheet of index
* `index_style`
* The location of stylesheet for the front page, relative to root folder
* `./style.css` by default
* Custom favicon
* `favicon`
* Custom favicon
* `""` by default
* RSS feed
* `rss_options`
* Specified necessary information for RSS. If present, feed is automatically generated.
* `title`, `description` and `link` must be present, i.e.:
```json
{
"rss_options": {
"title": "My amazing blog!",
"description": "This is a blog about amazing stuff",
"link": "https://amazing-example-blog.com"
}
}
```
* Git History Integration
* `git_history`
* Integrates with git to 1) show the latest commit message of a post and 2) link to the latest changelog at the bottom of the page
* `enabled` specifies it is enabled or not. `false` by default.
* `host` specifies where the git repo is hosted, for correct links. `"none"` by default. Can be either `"github"`, `"sourcehut"` or `"none"`. In the latter case, no links will be shown.
```json
{
"git_history": {
"enabled": true,
"host": "sourcehut",
"username": "olaven",
"repo_name": "markblog"
}
}
```