Skip to content

Commit

Permalink
Merge pull request #3 from marcusleonas/develop
Browse files Browse the repository at this point in the history
Updated docs
  • Loading branch information
marcusleonas authored Aug 6, 2024
2 parents 9560325 + 41ec70b commit 01c41f2
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/pages/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,27 @@ and outputs it to stdout.
notebuter read <name>
```

## Build your notes to html

To build your notes to a static html site, run:

```sh
notebutler build
```

This will create a `html` directory in the current directory, with all your notes
converted to html. This includes pico css for styling.

## Serve your notes for local development

To serve your notes for local development, run:

```sh
notebutler serve
```

This will start a local server on port 8080.

## Issues / Feature Requests

If you have any issues or feature requests, please open an issue on the
Expand Down
8 changes: 8 additions & 0 deletions docs/pages/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,20 @@ folder will be automatically detected and can be used when creating new notes.

`Name`: The name of the note.

`Notebook`: The name of the notebook the note is in.

`CreatedAt`: The date and time the note was created.

`Date`: The date the note was created.

`Time`: The time the note was created.

## Example

```md
# {{ .Name }}

This is a new note created at {{ .CreatedAt }}.

In {{ .Notebook }}
```

0 comments on commit 01c41f2

Please sign in to comment.