Skip to content
This repository has been archived by the owner on May 25, 2024. It is now read-only.

Commit

Permalink
add docs init
Browse files Browse the repository at this point in the history
  • Loading branch information
EdamAme-x committed Sep 30, 2023
1 parent b11baea commit 28070bb
Show file tree
Hide file tree
Showing 9 changed files with 865 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
*Naxt.js* is a framework based on [Hono](https://github.com/honojs/hono)🔥.
We are aiming for a **Japanese-made** framework.

Ultra-fast framework 🔥

on 🦕 Deno and ... coming soon.

## Features
Expand Down
13 changes: 13 additions & 0 deletions assets/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Mozilla Public License
You are free:

to share – to copy, distribute and transmit the work
to remix – to adapt the work
Under the following terms:

liability – the author doesn't provide any warranty and doesn't accepts any liability
copyright notice – a copy of the license or copyright notice must be included with software
trademark use – does not grand trademark rights.
share alike – If you remix, transform, or build upon the material, you have to distribute your work with Mozilla Public License

from (c) YANDEX
Binary file added assets/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

node_modules
dist
dist-ssr
*.local

# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
8 changes: 8 additions & 0 deletions docs/docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { defineConfig } from "vitepress";

// https://vitepress.vuejs.org/config/app-configs
export default defineConfig({
title: "Naxt.js 🔥",
description: "Ultra-fast framework using Hono",
head: [["link", { rel: "icon shortcut", href: "/assets/favicon.png" }]],
});
Binary file added docs/docs/assets/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 54 additions & 0 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Welcome to Naxt.js 🔥

<div style="display: flex; justify-content: between; align-items: center; margin-top: 16px"> <img src="/assets/favicon.png" alt="Naxt.js" width="64" height="64"/> <p style="font-size: 24px; margin-left: 8px">Ultra-fast framework using Hono 🔥</p> </div>

## Introduction

This framework is built using **[Hono](https://github.com/honojs/hono)** and **[Deno](https://deno.land)**. In the future, `bun / nodejs` will also be supported.

### Routing is done in File Structure Base. and NoBuild.

```text
|-routes
|-- index.js
|-- about.ts
|-api
|-- firebase.ts
```

In the above file structure...

`Req: /index => /index.js`
`Req: /about => /about.ts`
`Req: /api/firebase => /api/firebase.ts`

The file must contain the following code.

```js
export default function Index({ context, connInfo }) {
return context.html(`
<h1>Hello Naxt.js!</h1>
`);
}
```

The arguments are the same as for Hono.
However, some of them are unique. Later description.

URLpattern(as /user/@id as /user/:id) can also be used for routing.

Normal files (photos, etc.) will be routed as usual.

```text
|-routes
|-- index.js
|-- about.ts
|-api
|-- firebase.ts
|-photos
|-- index.css
```

`Req: /photos/index.css => /photos/index.css`

... in the middle of writing
21 changes: 21 additions & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"name": "vitepress-project",
"private": true,
"type": "module",
"scripts": {
"dev": "vitepress dev docs",
"build": "vitepress build docs",
"serve": "vitepress serve docs"
},
"devDependencies": {
"vue": "3.2.44",
"vitepress": "1.0.0-alpha.28"
},
"pnpm": {
"peerDependencyRules": {
"ignoreMissing": [
"@algolia/client-search"
]
}
}
}
Loading

0 comments on commit 28070bb

Please sign in to comment.