Skip to content

Commit

Permalink
feat: new docs framework
Browse files Browse the repository at this point in the history
  • Loading branch information
ayushsharma82 committed Oct 27, 2024
1 parent f7e6ec2 commit 95e432a
Show file tree
Hide file tree
Showing 95 changed files with 8,014 additions and 28,748 deletions.
3 changes: 3 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "next/core-web-vitals"
}
45 changes: 32 additions & 13 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,21 +1,40 @@
# Dependencies
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.*
.yarn/*
!.yarn/patches
!.yarn/plugins
!.yarn/releases
!.yarn/versions

# Production
/build
/portal
# testing
/coverage

# Generated files
.docusaurus
.cache-loader
# next.js
/.next/
/out/

# production
/build

# Misc
# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*
yarn-error.log*

# env files (can opt-in for commiting if needed)
.env*

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts
49 changes: 24 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,40 @@
# ElegantOTA Docs
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/pages/api-reference/create-next-app).

This documentation is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
## Getting Started

### Installation
First, run the development server:

```
$ yarn
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```

### Local Development
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

```
$ yarn start
```
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
[API routes](https://nextjs.org/docs/pages/building-your-application/routing/api-routes) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.

### Build
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/pages/building-your-application/routing/api-routes) instead of React pages.

```
$ yarn build
```
This project uses [`next/font`](https://nextjs.org/docs/pages/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.

This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Learn More

### Deployment
To learn more about Next.js, take a look at the following resources:

Using SSH:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn-pages-router) - an interactive Next.js tutorial.

```
$ USE_SSH=true yarn deploy
```
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!

Not using SSH:
## Deploy on Vercel

```
$ GIT_USER=<Your GitHub username> yarn deploy
```
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/pages/building-your-application/deploying) for more details.
3 changes: 0 additions & 3 deletions babel.config.js

This file was deleted.

5 changes: 0 additions & 5 deletions blog/authors.yml

This file was deleted.

7 changes: 7 additions & 0 deletions components/Badge.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export default function Badge() {
return (
<span className="_flex _items-center">
<img src="/pro-badge.gif" width={32} />
</span>
)
}
18 changes: 18 additions & 0 deletions components/ProCallout.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { Callout } from 'nextra/components'

export default function ProCallout() {
return (
<a href="https://elegantota.pro" target="_blank">
<Callout type="info" emoji={<img src="/pro-badge.gif" className='block' alt="" width={48} />}>
<div className='flex flex-row items-center gap-2'>
<span>
This feature is only available in ElegantOTA Pro
</span>
<span className='block mb-1'>
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-external-link"><path d="M15 3h6v6"/><path d="M10 14 21 3"/><path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"/></svg>
</span>
</div>
</Callout>
</a>
)
}
48 changes: 0 additions & 48 deletions docs/disable-filesystem-ota.md

This file was deleted.

49 changes: 0 additions & 49 deletions docs/disable-firmware-ota.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs/examples.md

This file was deleted.

57 changes: 0 additions & 57 deletions docs/installation.md

This file was deleted.

28 changes: 0 additions & 28 deletions docs/intro.md

This file was deleted.

Loading

0 comments on commit 95e432a

Please sign in to comment.