Merge pull request #4 from marcusleonas/develop

update documentation
marcusleonas · Sep 9, 2024 · 78d0249 · 78d0249
2 parents 01c41f2 + aa34847
commit 78d0249
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 3 deletions.
diff --git a/docs/malta.config.json b/docs/malta.config.json
@@ -10,7 +10,8 @@
       "pages": [
         ["Getting Started", "/"],
         ["Configuration", "/config"],
-        ["Templates", "/templates"]
+        ["Templates", "/templates"],
+        ["Planned Features", "/planned-features"]
       ]
     }
   ],

diff --git a/docs/pages/index.md b/docs/pages/index.md
@@ -16,6 +16,9 @@ curl -L https://github.com/marcusleonas/notebutler/releases/latest/download/<ver
 install notebtler /usr/local/bin
 ```
 
+On windows, you can download the binary from the [releases page](https://github.com/marcusleonas/notebutler/releases)
+and add it to your PATH.
+
 ## Initialise a new notebook
 
 Initialising a new notebook is as simple as running:
@@ -63,7 +66,7 @@ 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.
+converted to html. This includes [picocss](https://picocss.com/) for styling.
 
 ## Serve your notes for local development
 

diff --git a/docs/pages/planned-features.md b/docs/pages/planned-features.md
@@ -0,0 +1,14 @@
+---
+title: "Planned Features - Notebutler"
+---
+
+# Planned Features
+
+These are some of the features that I'm planning to add to Notebutler in the
+future.
+
+- A sharing system for notes.
+- Working frontmatter in templates. Would be useful for building websites (e.g. naming documents, etc)
+
+If you have any suggestions or feature requests, please
+[open an issue](https://github.com/marcusleonas/notebutler/issues/new).
diff --git a/docs/pages/templates.md b/docs/pages/templates.md
@@ -6,7 +6,7 @@ title: "Templates - Notebutler"
 
 Templates are quite limited at the moment, but I'm planning to add more features
 soon. At the moment, there are two variables that you can parse into your template.
-Frontmatter isn't function yet, but included in the default template. Templates
+Frontmatter isn't function yet, but it's included in the default template. Templates
 are written in [Go's text/template](https://golang.org/pkg/text/template/) format,
 and stored in the `.notebutler/templates` directory. Any markdown file in that
 folder will be automatically detected and can be used when creating new notes.