Skip to content

Commit

Permalink
docs: update document web
Browse files Browse the repository at this point in the history
  • Loading branch information
thuongtruong109 committed Nov 24, 2024
1 parent c7b1ff6 commit 5d36631
Show file tree
Hide file tree
Showing 22 changed files with 201 additions and 201 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto eol=lf
2 changes: 1 addition & 1 deletion docs/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ dist
.temp
cache

docs/.vitepress/cache
.vitepress/cache
166 changes: 0 additions & 166 deletions docs/_tmp.ts

This file was deleted.

140 changes: 114 additions & 26 deletions docs/docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -1,42 +1,130 @@
import { defineConfig } from 'vitepress';
import { createRequire } from 'module'

const require = createRequire(import.meta.url)
const pkg = require('../../package.json')

// refer https://vitepress.dev/reference/site-config for details
export default defineConfig({
lang: 'en-US',
title: 'VitePress',
description: 'Vite & Vue powered static site generator.',
title: 'Gouse',
description: 'A modern essential Golang utility package delivering consistency, modularity, performance, & extras presets',

themeConfig: {
nav: [
{ text: 'Example', link: '/example' },

{
text: 'Dropdown Menu',
items: [
{ text: 'Item A', link: '/item-1' },
{ text: 'Item B', link: '/item-2' },
{ text: 'Item C', link: '/item-3' },
],
},
sitemap: {
hostname: 'http://localhost:3000',
},

// ...
head: [
[
'script',
{ id: 'register-sw' },
`;(() => {
if ('serviceWorker' in navigator) {
navigator.serviceWorker.register('/sw.js')
}
})()`
],
[
'favicon',
{ rel: 'icon', type: 'image/ico', href: '/img/favicon.ico' }
]
],

sidebar: [
themeConfig: {
nav: [
{
text: 'Guide',
items: [
{ text: 'Example', link: '/example' },
// ...
],
text: 'Introduction',
link: '/introduction/what-is-gouse',
activeMatch: '/introduction/'
},
{
text: 'Receipts',
items: [
{ text: 'Receipt', link: '/example' },
// ...
],
link: '/receipts/array',
activeMatch: '/receipts/'
},
{
text: `v${pkg.version}`,
items: [
{
text: 'Changelog',
link: 'https://github.com/thuongtruong109/gouse/blob/main/CHANGELOG.md'
},
{
text: 'Contributing',
link: 'https://github.com/thuongtruong109/gouse/blob/main/.github/CONTRIBUTING.md'
}
]
}
],

sidebar: {
'/introduction/': {
base: '/introduction/',
items: [
{ text: 'What is Gouse?', link: 'what-is-gouse' },
{ text: 'Getting Started', link: 'getting-started' },
]

},
'/receipts/': {
base: '/receipts/',
items: [
{ text: 'Api', link: 'api' },
{ text: 'Array', link: 'array' },
{ text: 'Cache', link: 'cache' },
{ text: 'Chart', link: 'chart' },
{ text: 'Config', link: 'config' },
{ text: 'Connection', link: 'connection' },
{ text: 'Console', link: 'console' },
{ text: 'Cron', link: 'cron' },
{ text: 'Crypto', link: 'crypto' },
{ text: 'Date', link: 'date' },
{ text: 'Function', link: 'function' },
{ text: 'I/O', link: 'io' },
{ text: 'Log', link: 'Log' },
{ text: 'Math', link: 'math' },
{ text: 'Media', link: 'media' },
{ text: 'Net', link: 'net' },
{ text: 'Number', link: 'number' },
{ text: 'OS', link: 'os' },
{ text: 'Random', link: 'random' },
{ text: 'Regex', link: 'regex' },
{ text: 'String', link: 'string' },
{ text: 'Struct', link: 'struct' },
{ text: 'Type', link: 'type' },

// { text: 'Path', link: 'path' },
// { text: 'Security', link: 'security' },
// { text: 'Web', link: 'web' },
// { text: 'Worker', link: 'worker' },
// { text: 'XML', link: 'xml' },
// { text: 'Zip', link: 'zip' },
// { text: 'Zlib', link: 'zlib' },
// { text: 'Collection', link: 'collection' },
// { text: 'Convert', link: 'convert' },
// { text: 'Debug', link: 'debug' },
// { text: 'File', link: 'file' },
// { text: 'Hash', link: 'hash' },
// { text: 'Http', link: 'http' },
// { text: 'Json', link: 'json' },
// { text: 'Object', link: 'object' },
// { text: 'Time', link: 'time' },
// { text: 'Uuid', link: 'uuid' },
// { text: 'Validate', link: 'validate' },
// { text: 'Web', link: 'web' },
// { text: 'Xml', link: 'xml' }
]
},
},

editLink: {
pattern: 'https://github.com/thuongtruong109/gouse/edit/main/docs/docs/:path',
text: 'Edit this page on GitHub'
},

footer: {
message: 'Released under the MIT License.',
copyright: 'Copyright © 2024-present Tran Nguyen Thuong Truong'
}
},
});
});
Loading

0 comments on commit 5d36631

Please sign in to comment.