docs: migrate to vuepress

Author: oknozor

docs/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+.temp
+.cache

docs/docs/.vuepress/config.ts

@@ -0,0 +1,64 @@
+import {defaultTheme, defineUserConfig} from 'vuepress'
+import {searchPlugin} from "@vuepress/plugin-search";
+
+export default defineUserConfig({
+    lang: 'en-US',
+    title: ' ',
+    description: 'A Dotfile manager written in Rust',
+    markdown: {
+        code: {
+            lineNumbers: false
+        }
+    },
+    head: [
+        ['link', {rel: 'icon', href: '/favicon.png'}],
+        ['meta', {name: 'theme-color', content: '#f86b6a'}],
+        ['meta', {name: 'apple-mobile-web-app-capable', content: 'yes'}],
+        ['meta', {name: 'apple-mobile-web-app-status-bar-style', content: 'black'}],
+        ['meta', {property: 'og:title', content: 'Toml Bombadil'}],
+        ['meta', {property: 'og:image', content: 'https://toml-bombadil.dev/logo.png'}],
+        ['meta', {property: 'twitter:card', content: 'https://toml-bombadil.dev/logo.png'}],
+        ['meta', {property: 'og:description', content: 'A Dotfile manager written in Rust'}],
+        ['meta', {property: 'og:width', content: '100'}],
+    ],
+
+    plugins: [
+        searchPlugin({
+            // options
+        }),
+    ],
+
+    theme: defaultTheme({
+        logo: 'logo.png',
+        repo: 'https://github.com/cocogitto/cocogitto',
+        docsRepo: 'https://github.com/cocogitto/website',
+        navbar: [
+            {
+                link: '/quickstart/',
+                text: 'Quickstart',
+            },
+            {
+                link: '/docs/',
+                text: 'Documentation',
+            },
+            {
+                link: '/config/',
+                text: 'Configuration reference',
+            },
+        ],
+        sidebar: [
+            {
+                link: '/quickstart/',
+                text: 'User quickstart',
+            },
+            {
+                link: '/docs/',
+                text: 'Documentation',
+            },
+            {
+                link: '/config/',
+                text: 'Configuration reference',
+            },
+        ],
+    }),
+})

docs/docs/.vuepress/public/assets/toml-bombadil.gif

@@ -0,0 +1,72 @@
+---
+home: true
+heroImage: logo.png
+tagline: A Dotfile manager written in Rust
+actionText: Getting Started →
+actionLink: /quickstart/
+features:
+  - title: Dotfiles Template️
+    details: Inject variables in your dotfiles to manage your dotfile state in one place.
+  - title: GPG encryption
+    details: Encrypt your SSH keys, passwords, corporate configs via GPG and safely commit them to your public dotfile repository.
+  - title: Themes and profiles
+    details: Organize your dotfiles, switch themes and working environment on the fly.
+  - title: Installation hooks.
+    details: Live reload your window manager components with pre and post installation hooks.
+footer: MIT Licensed | Copyright © 2020 Paul Delafosse
+---
+
+### What are dotfiles anyway?
+
+If you don't know what dotfiles are, you probably want to read this.
+
+
+## Why Another dotfile manager
+
+I wrote Toml Bombadil because I kept changing my desktop environment : switching from i3 to sway, 
+from sway to xfce, from xfce to gnome and back to sway. When you keep changing your working 
+environment like this you end up with several problems :
+
+- Some symlinks will end up orphans.
+- Not every program you use support Xresources and you will most probably have to manually edit some themes/config.
+- When starting a fresh installation you will very likely need to adapt your existing dotfiles to your new machine.
+- It is a mess!
+
+Toml Bombadil try to solve this with a simple addition to the symlink method used by other tools: 
+instead of creating a symlink from a dotfile to the actual config path of a program, it will create 
+a copy of it and symlink the copy. This additional step allow to use your original dotfile as a 
+template and inject variables in the copy. You can have multiple value files in the same dotfile 
+repository and change color scheme, or any value on the fly.
+While Toml Bombadil has all those features available you could start using it only to generate 
+symlinks and templatize your dot file progressively.
+
+## Installation
+
+[![Packaging status](https://repology.org/badge/vertical-allrepos/toml-bombadil.svg)](https://repology.org/project/toml-bombadil/versions)
+
+### Archlinux
+
+```shell
+pacman -S toml-bombadil
+```
+
+### Cargo
+
+```shell
+cargo install toml-bombadil
+```
+
+
+## Alternatives
+
+The awesome-dotfiles repo maintain a list of dotfile managers.
+Before writing Toml Bombadil, I was using [dotbot](https://github.com/anishathalye/dotbot), it's easy to configure and simple to use.
+I wanted something a bit more configurable but [chezmoi](https://www.chezmoi.io/) felt way too complicated.
+If you want the heavy artillery, chezmoi is probably what you are looking for.
+
+
+
+## Contributing
+
+Find out how to contribute to Toml Bombadil [-> Contributing](../contributing.md)
+

docs/docs/.vuepress/public/logo.png

@@ -0,0 +1 @@
+TODO

docs/docs/README.md

@@ -0,0 +1,44 @@
+## How can I help
+
+Toml-bombadil is a small project but there is always something to be done, if you wish to contribute there are
+several ways you can help us :
+
+### Finding bugs
+
+Found a bug in Toml Bombadil ? Let us know by [opening an issue](https://github.com/oknozor/toml-bombadil/issues/new?assignees=oknozor&labels=bug&template=bug_report.md&title=%5BBUG%5D%5B).
+
+### Writing blogposts
+
+You just migrated your dotfiles to Toml Bombadil and want to share the experience ? Let us know, so we can reference your article.
+
+### Working on existing issues
+
+Toml Bombadil new features are grouped in a milestone for the [next version](https://github.com/oknozor/toml-bombadil/milestones).
+You might want to look at this first to get a grasp of want is currently going on.   
+If you want to work on an issue, let us know by tagging [@oknozor](https://github.com/oknozor) on the comment section.
+We will be happy to provide guidance and respond to your questions.
+You might want to pick a tagged [good first issue](https://github.com/oknozor/toml-bombadil/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
+
+### Write bats tests
+If you have spotted a bug, a great way to help us improve toml bombadil is to write a
+[bats](https://bats-core.readthedocs.io/en/latest/) test to reproduce it, see [HOWTO](https://github.com/oknozor/toml-bombadil/blob/main/bats-tests/HOWTO.md) for more info.
+
+### Suggesting new features
+
+You have an idea for a new feature ? You are welcome to open a [feature request](https://github.com/oknozor/toml-bombadil/issues/new?assignees=oknozor&labels=enhancement&template=feature_request.md&title=%5BFEATURE%5D)
+on the issue board.
+
+### Submit a pull request
+
+Toml bombadil respect the following coding standard for any code addition to the main branch :
+- We use [clippy](https://github.com/rust-lang/rust-clippy) to spot lints.
+- We enforce code formatting with [rustfmt](https://github.com/rust-lang/rustfmt).
+- We write test (Code coverage must never decrease when merging to the main branch).
+- Commit shall respect the [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) specification
+
+You have picked an issue and started to work on your fork. Time to make a pull request !
+If your issue is referenced in the next version milestone, you are expected to submit a pull request to the corresponding
+version branch (following semver format and prefixed by "v", ex : "v2.0.0-rc").
+If your issue is a bug fix you can submit your PR to main directly and increase the minor version. 
+
+