diff --git a/docs/app.config.ts b/docs/app.config.ts index f17c2d2..33ab738 100644 --- a/docs/app.config.ts +++ b/docs/app.config.ts @@ -1,18 +1,11 @@ // https://github.com/nuxt-themes/docus/blob/main/nuxt.schema.ts export default defineAppConfig({ + docus: { + title: 'Griffin', description: 'Automate your post-installation tasks with Ansible', - // image: 'https://user-images.githubusercontent.com/904724/185365452-87b7ca7b-6030-4813-a2db-5e65c785bf88.png', - // socials: { - // twitter: 'nuxt_js', - // github: 'nuxt-themes/docus', - // nuxt: { - // label: 'Nuxt', - // icon: 'simple-icons:nuxtdotjs', - // href: 'https://nuxt.com' - // } - // }, + github: { dir: 'docs/content', branch: 'master', @@ -20,20 +13,40 @@ export default defineAppConfig({ owner: 'terrorsquad', edit: true }, + aside: { level: 0, collapsed: false, exclude: [] }, + main: { padded: true, - fluid: true + fluid: false }, + header: { logo: false, showLinkIcon: true, exclude: [], - fluid: true - } + fluid: false + }, + + titleTemplate: '%s ยท Griffin', + + socials: { + github: 'terrorsquad/ansible-post-installation', + }, + + layout: 'default', + + footer: { + credits: { + icon: '๐Ÿš€', + text: 'By Goran Ninkovic 2024', + href: 'https://goranninkovic.com' + }, + fluid: false + }, } }) diff --git a/docs/content/1.documentation/1.getting-started.mdc b/docs/content/1.documentation/1.getting-started.md similarity index 95% rename from docs/content/1.documentation/1.getting-started.mdc rename to docs/content/1.documentation/1.getting-started.md index 54d2855..a2bb659 100644 --- a/docs/content/1.documentation/1.getting-started.mdc +++ b/docs/content/1.documentation/1.getting-started.md @@ -60,7 +60,7 @@ These playbooks are designed to work on Debian-based Linux systems, including: ## Get Started Today! ::alert{type="info"} -Ready to experience the power of Griffin? Head over to our [Installation Guide](link-to-installation-guide) and unlock a new level of Linux productivity! +Ready to experience the power of Griffin? Head over to our [Installation Guide](installation) and unlock a new level of Linux productivity! :: ## Still Have Questions? diff --git a/docs/content/1.documentation/2.installation.mdc b/docs/content/1.documentation/2.installation.md similarity index 100% rename from docs/content/1.documentation/2.installation.mdc rename to docs/content/1.documentation/2.installation.md diff --git a/docs/content/1.documentation/3.usage.mdc b/docs/content/1.documentation/3.usage.md similarity index 100% rename from docs/content/1.documentation/3.usage.mdc rename to docs/content/1.documentation/3.usage.md diff --git a/docs/content/1.documentation/4.whats-installed.mdc b/docs/content/1.documentation/4.whats-installed.md similarity index 100% rename from docs/content/1.documentation/4.whats-installed.mdc rename to docs/content/1.documentation/4.whats-installed.md diff --git a/docs/content/1.documentation/5.testing.mdc b/docs/content/1.documentation/5.testing.md similarity index 100% rename from docs/content/1.documentation/5.testing.mdc rename to docs/content/1.documentation/5.testing.md diff --git a/docs/content/1.documentation/6.faq.mdc b/docs/content/1.documentation/6.faq.md similarity index 100% rename from docs/content/1.documentation/6.faq.mdc rename to docs/content/1.documentation/6.faq.md diff --git a/docs/content/1.documentation/7.CONTRIBUTING.mdc b/docs/content/1.documentation/7.CONTRIBUTING.md similarity index 100% rename from docs/content/1.documentation/7.CONTRIBUTING.mdc rename to docs/content/1.documentation/7.CONTRIBUTING.md diff --git a/docs/content/1.documentation/9.license.md b/docs/content/1.documentation/9.license.md new file mode 100644 index 0000000..c03da54 --- /dev/null +++ b/docs/content/1.documentation/9.license.md @@ -0,0 +1,26 @@ + +## License + +This project is licensed under the [MIT License](https://opensource.org/license/mit). + +The MIT License (MIT) + +Copyright (c) 2024 Goran Ninkovic + +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.