High performant static blog generator.
To view an existing blog generated with
The following is to setup your environment to run
Run the following command to execute
docker run -v $(pwd):/context -u `id -u $USER`:`id -g $USER` natewilkins/reblog
To make things easier there's a helper script to run the above command more easily.
You can run the following to symlink the helper file into your
NOTE: Make sure that
$HOME/bin is in your
git clone https://github.com/nate-wilkins/reblog ~/.local/src/reblog chmod +x ~/.local/src/reblog/run-container.sh ln -sf ~/.local/src/reblog/run-container.sh ~/bin/reblog reblog
NOTE: Not available yet. Come back later.
reblog from hex using the following command.
mix archive.install hex reblog
Once installed you can run
- Initialize a new blog.
reblog init my-blog
This will create a new blog with the following structure.
my-blog/ ├─ _site/ ├─ assets/ │ └─ favicon.svg ├─ pages/ │ └─ about.eex ├─ posts/ │ ├─ 2018-1-1_hello-world.md │ └─ .layout.eex └─ .layout.eex
- Build the blog.
- Deploy the blog locally.
reblog deploy -t local -a port=7575
- Open a browser to http://localhost:7575
To add a new blog post just add a new markdown post to the
posts directory following the
You can also use the
reblog post command to automatically create a new post.
reblog post my-post-title
To add a custom page just add a new markdown page to the
You can also use the
reblog page command to automatically create a new page.
reblog page my-page-title
To build using a different theme run
reblog build -t <theme> where
<theme> is a valid theme.
To list all available themes run
reblog theme --list or visit themes.md to learn more.
NOTE: It is highly suggested that you start out with a preexisting theme before moving on to a custom one.
reblog theme --new
The general idea is to constantly rebuild the blog while developing your theme.
reblog deploy -t local -a port=7575 livereload
To deploy using a different provider run
reblog deploy -p <provider> where
<provider> is a valid provider.
To list all available providers run
reblog provider --list or visit providers.md to learn more.
To test run
escript reblog with the arguments you want to test with.
When making changes make sure to keep the schema in mind.