Skip to content
This repository has been archived by the owner on Oct 2, 2023. It is now read-only.

Commit

Permalink
feat: init docs with vitepress
Browse files Browse the repository at this point in the history
  • Loading branch information
nexxeln committed Nov 28, 2022
1 parent 9595ba6 commit 944c7e8
Show file tree
Hide file tree
Showing 5 changed files with 831 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
plugin/packer_compiled.lua
web/node_modules
22 changes: 22 additions & 0 deletions web/docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import { defineConfig } from "vitepress";

export default defineConfig({
lang: "en-US",
title: "nexxel • nvim",
description: "Documentation for nexxel's Neovim configuration",
cleanUrls: "with-subfolders",
markdown: {
theme: "vitesse-dark",
},
themeConfig: {
siteTitle: "nexxel • nvim",
nav: [
{ text: "Installation", link: "/installation" },
{ text: "Guide", link: "/guide" },
{ text: "Configuration", link: "/configuration" },
],
footer: {
message: "Released under the MIT license",
},
},
});
14 changes: 14 additions & 0 deletions web/docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
layout: home

hero:
name: nexxel • nvim
text: Minimal & Extensible Neovim Config
actions:
- theme: brand
text: Installation
link: /installtion
- theme: alt
text: View on GitHub
link: https://github.com/nexxeln/nvim
---
18 changes: 18 additions & 0 deletions web/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"name": "docs",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"docs:dev": "vitepress dev docs",
"docs:build": "vitepress build docs",
"docs:serve": "vitepress serve docs"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"vitepress": "1.0.0-alpha.29",
"vue": "^3.2.45"
}
}
Loading

0 comments on commit 944c7e8

Please sign in to comment.