Skip to content

Commit

Permalink
[skip_publish, deploy_docs]
Browse files Browse the repository at this point in the history
Setting up docs pages
  • Loading branch information
zaaakher committed Sep 22, 2023
1 parent 5e87226 commit c3b5e57
Show file tree
Hide file tree
Showing 29 changed files with 185 additions and 280 deletions.
24 changes: 3 additions & 21 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,5 @@
# Nextra Docs Template
# Hajar Documentation

This is a template for creating documentation with [Nextra](https://nextra.site).
[Docs](https://hajar.sikka.io)

[**Live Demo →**](https://nextra-docs-template.vercel.app)

[![](.github/screenshot.png)](https://nextra-docs-template.vercel.app)

## Quick Start

Click the button to clone this repository and deploy it on Vercel:

[![](https://vercel.com/button)](https://vercel.com/new/clone?s=https%3A%2F%2Fgithub.com%2Fshuding%2Fnextra-docs-template&showOptionalTeamCreation=false)

## Local Development

First, run `pnpm i` to install the dependencies.

Then, run `pnpm dev` to start the development server and visit localhost:3000.

## License

This project is licensed under the MIT License.
Made with next.js & nextra.
7 changes: 7 additions & 0 deletions docs/components/footer.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import React from "react";

const Footer = () => {
return <div>F</div>;
};

export default Footer;
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"license": "MIT",
"homepage": "https://hajar.sikka.io",
"dependencies": {
"@sikka/hawa": "^0.2.3",
"@sikka/hawa": "^0.2.19-beta",
"next": "^13.0.6",
"nextra": "latest",
"nextra-theme-docs": "latest",
Expand Down
5 changes: 5 additions & 0 deletions docs/pages/404.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { NotFoundPage } from 'nextra-theme-docs'

# 404: Page Not Found

<NotFoundPage />
2 changes: 1 addition & 1 deletion docs/pages/_app.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import "../styles.css";
import "@sikka/hawa/src/styles.css";
import "@sikka/hawa/dist/style.css";

export default function App({ Component, pageProps }) {
return <Component {...pageProps} />;
Expand Down
23 changes: 14 additions & 9 deletions docs/pages/_meta.json
Original file line number Diff line number Diff line change
@@ -1,23 +1,28 @@
{
"index": {
"title": "Introduction",
"title": "Hajar",
"type": "page",
"display": "hidden"
"display": "hidden",
"theme": {
"layout": "raw"
}
},
"docs": {
"type": "page",
"title": "Docs"
},
"another": "Another Page",
"advanced": "Advanced (A Folder)",
"about": {
"title": "About",
"type": "page"
},

"contact": {
"title": "Contact ↗",
"type": "page",
"href": "https://twitter.com/shuding_",
"href": "https://twitter.com/sikka_sa",
"newWindow": true
},
"404": {
"type": "page",
"theme": {
"timestamp": false,
"typesetting": "article"
}
}
}
17 changes: 17 additions & 0 deletions docs/pages/docs/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"index": "Introduction",

"--Methods": {
"title": "Methods",
"type": "separator"
},

"authentication": "Authentication",
"database": "Database",
"email": "Emails",
"storage": "Storage",
"--queries": {
"title": "Queries",
"type": "separator"
}
}
3 changes: 0 additions & 3 deletions docs/pages/docs/about.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions docs/pages/docs/advanced.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions docs/pages/docs/advanced/satori.mdx

This file was deleted.

31 changes: 0 additions & 31 deletions docs/pages/docs/another.mdx

This file was deleted.

1 change: 1 addition & 0 deletions docs/pages/docs/authentication.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# This is authentication page
5 changes: 5 additions & 0 deletions docs/pages/docs/authentication/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"login": "Login",
"logout": "Logout",
"register": "Register"
}
1 change: 1 addition & 0 deletions docs/pages/docs/authentication/login.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# This is login page
1 change: 1 addition & 0 deletions docs/pages/docs/authentication/logout.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# this is logout page
1 change: 1 addition & 0 deletions docs/pages/docs/authentication/register.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# this is register page
1 change: 1 addition & 0 deletions docs/pages/docs/database.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# This is database page
3 changes: 3 additions & 0 deletions docs/pages/docs/database/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"setup": "SetupDatabase"
}
1 change: 1 addition & 0 deletions docs/pages/docs/database/setup.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# This is login page
141 changes: 0 additions & 141 deletions docs/pages/docs/function1.mdx

This file was deleted.

18 changes: 0 additions & 18 deletions docs/pages/docs/function2.mdx

This file was deleted.

18 changes: 0 additions & 18 deletions docs/pages/docs/function3.mdx

This file was deleted.

16 changes: 0 additions & 16 deletions docs/pages/docs/function4.mdx

This file was deleted.

Loading

0 comments on commit c3b5e57

Please sign in to comment.