adding to book

clpi · Dec 15, 2024 · e4a3566 · e4a3566
1 parent fd044b8
commit e4a3566
Show file tree

Hide file tree

Showing 60 changed files with 285 additions and 249 deletions.
diff --git a/Justfile b/Justfile
@@ -8,8 +8,10 @@ wl:
 	./scripts/bin/downls
 
 lnw:
+  rm -rf ./down
   ln -s ./scripts/bin/down ./down
 lnwl:
+  rm -rf ./down-lsp
   ln -s ./scripts/bin/down-lsp ./down-lsp
 
 iw: lnw

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # down.lua 
 
-### the _familiar_, organized future for neovim
+the _familiar_, organized future for neovim and beyond!
 
 <a href="https://neovim.io"> ![Neovim](https://img.shields.io/badge/Neovim%200.10+-brightgreen?style=for-the-badge) </a>
 <a href="./LICENSE"> ![License](https://img.shields.io/badge/license-GPL%20v3-brightgreen?style=for-the-badge)</a>
@@ -267,10 +267,6 @@ require("down").setup({ ---@type down.mod.Config
 
 ## Usage
 
-> [!Note]
->
-> Still early on in development!
-
 ### Modules
 
 - `config` - configuration settings
@@ -285,11 +281,11 @@ require("down").setup({ ---@type down.mod.Config
 >
 > Check out [TODO.md](./TODO.md) for a more detailed list of tasks
 
-## Support
+## Contributing
 
-> [!Note]
+> [!Tip]
 >
-> Still early on in development!
+> Check out [CONTRIBUTING.md](./CONTRIBUTING.md) for a more detailed overview of how to contribute
 
 ## Credits
 
@@ -311,7 +307,3 @@ thank you and keep updated!
 
 <!-- </div> -->
 
-```lua
----@type down.mod.Config
-
-```
diff --git a/assets/snippets/README.md b/assets/snippets/README.md
@@ -0,0 +1 @@
+# down.lua snippets
diff --git a/assets/template/README.md b/assets/template/README.md
@@ -0,0 +1 @@
+# down.lua templates
diff --git a/book/.gitignore b/book/.gitignore
@@ -1 +1 @@
-
+./book
diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md
@@ -29,6 +29,7 @@ Welcome -- to the `down.lua` book. I hope this helps!
 - [Modules](./modules/index.md)
 
   - [Introduction](./modules/intro.md)
+  - [Examples](./modules/example.md)
   - [Quickstart](./modules/quickstart.md)
 
 - [Customizing](./customizing/index.md)
@@ -46,7 +47,7 @@ Welcome -- to the `down.lua` book. I hope this helps!
     - [org](./export/frameworks/org.md)
   - [Styling](./export/styling.md)
 
-- [Publishing](./publish.md)
+- [Publishing](./publish/index.md)
 
   - [Frameworks](./publish/frameworks.md)
   - [Blog](./publish/blog.md)
@@ -68,12 +69,15 @@ Welcome -- to the `down.lua` book. I hope this helps!
 
 - [Tools](./tools/index.md)
 
+  - [Neovim](./tools/neovim.md)
+  - [Visual Studio Code](./tools/vscode.md)
+  - [Vim](./tools/vim.md)
   - [Mobile](./tools/mobile.md)
   - [Desktop](./tools/desktop.md)
   - [Cli](./tools/cli.md)
+  - [Emacs](./tools/emacs.md)
 
 - [Contributing](./contributing/intro.md)
-- [Final thoughts](./final_thoughts.md)
 - [Roadmap](./roadmap.md)
 - [Credits](./credits.md)
 - [Map](./index.md)
diff --git a/book/src/about/autocommands.md b/book/src/about/autocommands.md
@@ -0,0 +1 @@
+# Autocommands
diff --git a/book/src/about/commands.md b/book/src/about/commands.md
@@ -0,0 +1 @@
+# Commands
diff --git a/book/src/config/advanced.md b/book/src/config/advanced.md
@@ -0,0 +1 @@
+# Advanced Configuration
diff --git a/book/src/config/basic.md b/book/src/config/basic.md
@@ -0,0 +1 @@
+# Basic Configuration
diff --git a/book/src/config/setting-up.md b/book/src/config/setting-up.md
@@ -0,0 +1 @@
+# Setting up
diff --git a/book/src/contributing/discussions.md b/book/src/contributing/discussions.md
@@ -1 +1 @@
-# Contributing
+# Contributing to Discussions
diff --git a/book/src/contributing/index.md b/book/src/contributing/index.md
@@ -0,0 +1 @@
+# Contributing
diff --git a/book/src/contributing/intro.md b/book/src/contributing/intro.md
@@ -1 +1 @@
-# Contributing
+# Introduction to Contributing
diff --git a/book/src/contributing/issues.md b/book/src/contributing/issues.md
@@ -0,0 +1 @@
+# Contributing to Issues
diff --git a/book/src/contributing/sponsorship.md b/book/src/contributing/sponsorship.md
@@ -0,0 +1 @@
+# Sponsorship
diff --git a/book/src/credits.md b/book/src/credits.md
@@ -0,0 +1 @@
+# Credits
diff --git a/book/src/customizing/highlights.md b/book/src/customizing/highlights.md
@@ -0,0 +1 @@
+# Customizing highlights
diff --git a/book/src/customizing/index.md b/book/src/customizing/index.md
@@ -0,0 +1 @@
+# Customizing
diff --git a/book/src/customizing/themes.md b/book/src/customizing/themes.md
@@ -0,0 +1 @@
+# Customizing themes
diff --git a/book/src/export/pandoc.md b/book/src/export/pandoc.md
@@ -0,0 +1 @@
+# Exporting with Pandoc
diff --git a/book/src/export/styling.md b/book/src/export/styling.md
@@ -0,0 +1 @@
+# Exporting with Styling
diff --git a/book/src/extend/autocmd.md b/book/src/extend/autocmd.md
@@ -0,0 +1 @@
+# Extending with Autocommands
diff --git a/book/src/extend/index.md b/book/src/extend/index.md
@@ -0,0 +1 @@
+# Extending
diff --git a/book/src/extend/keymaps.md b/book/src/extend/keymaps.md
@@ -0,0 +1 @@
+# Extending keymaps
diff --git a/book/src/extend/modules.md b/book/src/extend/modules.md
@@ -0,0 +1 @@
+# Extending modules
diff --git a/book/src/extend/plugins.md b/book/src/extend/plugins.md
@@ -0,0 +1 @@
+# Extending with plugins
diff --git a/book/src/extend/themes.md b/book/src/extend/themes.md
@@ -1 +1 @@
-# Themes
+# Extending Themes
diff --git a/book/src/faq.md b/book/src/faq.md
@@ -0,0 +1 @@
+# Frequently Asked Questions
diff --git a/book/src/final_thoughts.md b/book/src/final_thoughts.md
diff --git a/book/src/help.md b/book/src/help.md
@@ -0,0 +1 @@
+# Help
diff --git a/book/src/modules/intro.md b/book/src/modules/intro.md
@@ -0,0 +1 @@
+# Module Introduction
diff --git a/book/src/modules/quickstart.md b/book/src/modules/quickstart.md
@@ -0,0 +1 @@
+# Module quickstart
diff --git a/book/src/note/2024/12/15.md b/book/src/note/2024/12/15.md
diff --git a/book/src/options.md b/book/src/options.md
@@ -0,0 +1 @@
+# Options
diff --git a/book/src/philosophy.md b/book/src/philosophy.md
@@ -0,0 +1 @@
+# Philosophy
diff --git a/book/src/plans/general.md b/book/src/plans/general.md
@@ -0,0 +1 @@
+# General Plans
diff --git a/book/src/plans/index.md b/book/src/plans/index.md
@@ -0,0 +1 @@
+# Plans
diff --git a/book/src/plans/near.md b/book/src/plans/near.md
@@ -0,0 +1 @@
+# Short-term Plans
diff --git a/book/src/plans/todo.md b/book/src/plans/todo.md
@@ -0,0 +1 @@
+# Todos
diff --git a/book/src/publish.md b/book/src/publish.md
diff --git a/book/src/publish/blog.md b/book/src/publish/blog.md
@@ -0,0 +1 @@
+# Publishing a Blog
diff --git a/book/src/publish/digital_garden.md b/book/src/publish/digital_garden.md
@@ -0,0 +1 @@
+# Publishing a Digital Garden
diff --git a/book/src/publish/frameworks.md b/book/src/publish/frameworks.md
@@ -0,0 +1 @@
+# Publishing with Frameworks
diff --git a/book/src/publish/index.md b/book/src/publish/index.md
@@ -0,0 +1 @@
+# Publishing
diff --git a/book/src/publish/wiki.md b/book/src/publish/wiki.md
@@ -0,0 +1 @@
+# Publishing a Wiki
diff --git a/book/src/roadmap.md b/book/src/roadmap.md
@@ -0,0 +1 @@
+# Roadmap
diff --git a/book/src/setup.md b/book/src/setup.md
@@ -0,0 +1 @@
+# Setup
diff --git a/book/src/tools/cli.md b/book/src/tools/cli.md
@@ -0,0 +1 @@
+# CLI
diff --git a/book/src/tools/desktop.md b/book/src/tools/desktop.md
@@ -0,0 +1 @@
+# Desktop
diff --git a/book/src/tools/emacs.md b/book/src/tools/emacs.md
@@ -0,0 +1 @@
+# Emacs
diff --git a/book/src/tools/index.md b/book/src/tools/index.md
@@ -0,0 +1 @@
+# Tools
diff --git a/book/src/tools/mobile.md b/book/src/tools/mobile.md
@@ -0,0 +1 @@
+# Mobile
diff --git a/book/src/tools/neovim.md b/book/src/tools/neovim.md
@@ -0,0 +1 @@
+# Neovim
diff --git a/book/src/tools/vim.md b/book/src/tools/vim.md
@@ -0,0 +1 @@
+# Vim
diff --git a/book/src/tools/vscode.md b/book/src/tools/vscode.md
@@ -0,0 +1 @@
+# Visual Studio Code
diff --git a/down b/down
@@ -0,0 +1 @@
+./scripts/bin/down
diff --git a/down-lsp b/down-lsp
@@ -0,0 +1 @@
+./scripts/bin/down-lsp
diff --git a/scripts/bin/down b/scripts/bin/down
@@ -2,7 +2,7 @@
 
 --+  +----------------------+ down +----------------------+  +--
 --+  |                                                    |  +--
---+  |    down       v0.1.0-alpha                         |  +--
+--+  |    down       v0.1.1-alpha                         |  +--
 --+  |                                                    |  +--
 --+  |    ABOUT                                           |  +--
 --+  |      down (down.lua) is a dev-focused note-taking  |  +--