Skip to content
/ raptr Public

🦖 Minimalistic and opinionated blogging engine.

Notifications You must be signed in to change notification settings

CodeF0x/raptr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

93 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome to raptr

raptr is a minimal, static site generator and blogging-engine. It's fast, easy to set-up and easy to use.


~ Features ~

  • use themes made by the community or create your own
  • edit and tweak existing themes
  • fast and easy to use with only the bare minimum of commands
  • outputs web-ready websites with all required assets -- just put it on your web server and you're ready to go
  • quickly create posts and write them in markdown
  • raptr comes as a small standalone for any system
  • built in dev-server to preview your site

~ Installation ~

You need Git, which you probably already have, and Cargo which is usally pretty easy to install. Once you've got both, run

cargo install raptr

in your terminal and you're done!

For other methods, see "Install raptr" in the official wiki.

~ Usage ~

A quick start guide is available here.

$raptr --help
raptr 0.2.0
Tobias "CodeF0x" Oettl <contact@codef0x.dev>
An opinionated blogging engine

USAGE:
    raptr [FLAGS] [OPTIONS]

FLAGS:
    -h, --help                  Prints help information
    -i, --include-all-drafts    Includes drafts that are not set to be generated when using --serve or --publish. Only
                                valid when used together with --serve or --publish.
    -V, --version               Prints version information
    -v, --verbose               Shows detailed errors and logging messages

OPTIONS:
    -d, --draft <DRAFT_NAME>            Creates a new draft
    -n, --new <PROJECT_NAME>            Creates a new project
    -p, --publish <OUTPUT_DIRECTORY>    Renders your drafts to web-ready html files [default: output]
    -s, --serve <PORT>                  Serves a preview at specified port or standard port if none is set [default:
                                        3000]