Skip to content

Commit

Permalink
Add user documentation to README
Browse files Browse the repository at this point in the history
  • Loading branch information
jmcharter committed Sep 16, 2024
1 parent 808ae3b commit a384fd7
Showing 1 changed file with 38 additions and 3 deletions.
41 changes: 38 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@

![lumaca_logo](https://github.com/jmcharter/lumaca/assets/3820235/763295a9-8dc9-4e66-af8a-024a40f077bf)

# Lumaca
> A simple static site generator written in Go.
### A simple static site generator written in Go.

## What is Lumaca?

Expand All @@ -14,4 +13,40 @@ The project is MIT licensed, so feel free to fork it, copy it, modify and genera
## Usage

### Installation
Clone the repository
The easiest way to get started with Lumaca is to use the Go package manager:

```sh
go install github.com/jmcharter/lumaca@latest
```

Alternatively, you can clone this repo and generate your own binary.

### Get Started

Once it's installed, create a new directory for your blog and run the `init` command:

```sh
mkdir MyBlog
cd MyBlog
lumaca init --author "John Doe" --title "MyBlog"
```

This will create a config file for you, which you can customize if you wish. It will also generate all of the boilerplate and template you need to get going.

To create your first blog post, use the `new` command.

```sh
lumaca new --title "My First Post"
```

A markdown file with some Frontmatter will be generated in your `Posts` directory (`content/posts`). Edit as appropriate, and when you're finished writing your post, you can run `build` to generate the html.

```sh
lumaca build
```

And if you'd like to see how it looks locally before deploying somewhere, you can run `serve`.

```sh
lumaca serve
```

0 comments on commit a384fd7

Please sign in to comment.