docula 0.0.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Jared Wray
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,52 @@
+<img src="site/branding-guidelines/Docula Logos/PNG/Color/docula.png" />
+
+# Docula
+
+[![tests](https://github.com/jaredwray/docula/actions/workflows/tests.yaml/badge.svg)](https://github.com/jaredwray/docula/actions/workflows/tests.yaml)
+[![codecov](https://codecov.io/github/jaredwray/docula/branch/main/graph/badge.svg?token=RS0GPY4V4M)](https://codecov.io/github/jaredwray/docula)
+
+## :warning: - this is currently under development. Please do not use.
+
+## Features
+
+- Zero Config - Just drop it in and it works
+- Can run from `npx` or installed globally
+- Knowledge Base that is easy to setup and manage
+- Beautiful and Responsive Design (Like Stripe or 11ty)
+- Search Engine Optimized
+- Search Engine Plugin (Algolia) that pushes the content to the search service.
+- Convention over Configuration - just add your files, use a template (or build your own) and you're done.
+- Will generate a sitemap.xml
+- Will generate a robots.txt
+- Will generate a release based on Github Releases
+- Generatses an RSS feed.xml file to use and share 
+
+## Site Structure
+
+- `site/docs` - contains the documentation files
+- `site/template` - contains the templates files
+- `site/blog` - contains the blog files and images
+
+This will all be generated in the `dist` folder by default. To change that you can use the `--output=<folder_name>` flag.
+
+### Github Integration
+- Pull all of your Contributors and Display Them
+- Pulls your release notes and puts it into a good looking data format for your templates
+- Pulls your project stats based on Github Forks, Stars, and Watchers
+## How the CLI should work
+To create a new project it should be as simple as:
+```bash
+docula init <project-name>
+```
+
+This will actually do all the scaffolding for the site setting up the package.json, the config file, and the templates. It will also install the default template.
+
+To build the site just do:
+```bash
+docula <path optional>
+```
+
+To build the site and watch for changes:
+```bash
+docula <path optional> --serve --watch --port=8081
+```

package/bin/docula.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+import {Executable} from '../dist/index.js';
+
+const docula = new Executable();
+
+// eslint-disable-next-line unicorn/prefer-top-level-await, n/prefer-global/process
+docula.parseCLI(process).then();

package/init/_data/site.json

@@ -0,0 +1,4 @@
+{
+  "authorName": "Jared Wray",
+  "footer":  "License MIT and Copyright"
+}