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

feat: initial setup nextra #44

Merged
merged 158 commits into from
Apr 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
158 commits
Select commit Hold shift + click to select a range
316f71e
feat: initial setup nextra
urmauur Mar 26, 2024
18e9129
chore: update blog layout and categories
urmauur Mar 26, 2024
e59f8aa
chore: fix conflict
urmauur Mar 26, 2024
7364045
chore: add package sharp for image production next
urmauur Mar 26, 2024
b2a89c8
chore: prepare integrate with google tag manager
urmauur Mar 26, 2024
d313e1f
chore: add banner homepage
urmauur Mar 26, 2024
f6a5b6a
chore: added link url to release
urmauur Mar 26, 2024
7256132
chore: add dummy result api when get rate limit
urmauur Mar 26, 2024
1e152fc
chore: cleanup light mode theme
urmauur Mar 26, 2024
5c784ee
chore: added banner link with new target
urmauur Mar 26, 2024
877cd27
chore: fix endpoint releases
urmauur Mar 26, 2024
1d240a3
chore: update types release changelog
urmauur Mar 26, 2024
1e65092
chore: add dropdown download component
urmauur Mar 26, 2024
10c580a
chore: update step using nextra step component
urmauur Mar 27, 2024
33a8566
chore: take a back features section
urmauur Mar 27, 2024
610617e
chore: update favicons
urmauur Mar 27, 2024
de1e67d
chore: preparing og image and some meta for SEO
urmauur Mar 27, 2024
eba6f16
Update CICD for nextra (#46)
hiento09 Mar 27, 2024
4d30dd1
chore: remove specifiec refirect from next config
urmauur Mar 27, 2024
0376f6a
chore: fix title toolbar
urmauur Mar 27, 2024
c421978
chore: fix issue api-reference
urmauur Mar 27, 2024
f78a1b4
chore: tweak navbar menu display
urmauur Mar 28, 2024
023fb65
chore: rename guides to documentation
urmauur Mar 28, 2024
c98e436
chore: fix responsive menu navbar
urmauur Mar 28, 2024
fde6cf7
chore: update link from guides to docs
urmauur Mar 28, 2024
84e38f4
chore: update thumbnail blog
urmauur Mar 28, 2024
06f4ad2
chore: redirect missing url
urmauur Mar 28, 2024
99a58da
docs: Rename extension
aindrajaya Mar 28, 2024
f28e715
docs: Update content and fix broken link in article
aindrajaya Mar 28, 2024
da7d6cf
docs: Update tabs and add image to Quickstart
aindrajaya Mar 28, 2024
6d1bd23
docs: Fix meta.json for jan extensions
aindrajaya Mar 28, 2024
d029312
docs: Nextra setup redirect the broken link
aindrajaya Mar 28, 2024
50bb54c
docs: Delete redirects from next.config and create manual redirects
aindrajaya Mar 28, 2024
160b451
chore: add section wall of love with carousel
urmauur Mar 28, 2024
b2fab05
chore: add plop js for create blog post via terminal
urmauur Mar 28, 2024
b1a49ac
chore: remove max width of container tweet
urmauur Mar 28, 2024
61e2006
chore: update markdown quickstart using bas instead brew codeblock
urmauur Mar 28, 2024
af9dc4c
chore: temporary fix scalar conflict theme with nextra
urmauur Mar 28, 2024
01d088b
feat: Jan desktop and server guide
hiro-v Mar 29, 2024
040d56f
chore: update missing categories
urmauur Mar 29, 2024
41851cf
chore: update fix clickable banner release
urmauur Mar 29, 2024
867348f
chore: fix conflict
urmauur Apr 1, 2024
94f73dd
chore: added step on docs dekstop
urmauur Apr 1, 2024
1d8a658
chore: wip update new section
urmauur Apr 1, 2024
d24786b
chore: update section social media card and update huggingface
urmauur Apr 1, 2024
19c1f1f
chore: update total downloaded user
urmauur Apr 1, 2024
48f7a8d
chore: update api structure section
urmauur Apr 1, 2024
6595413
chore: added download page
urmauur Apr 1, 2024
6be4626
Add _redirects file and change CI to deploy cloudflare (#65)
hiento09 Apr 1, 2024
c4b9bb0
docs: Reformat the inferences (engines) folder
aindrajaya Apr 1, 2024
d5224fa
docs: Update about section
aindrajaya Apr 1, 2024
5ffa7e1
docs: Updated the docs content and add assistans, models and quicstar…
aindrajaya Apr 1, 2024
8a34fc3
chore: update edirect
urmauur Apr 1, 2024
db84135
chore: update redirect
urmauur Apr 1, 2024
b9c8618
chore: update small improvement ui
urmauur Apr 1, 2024
e82e71e
chore: add robot txt
urmauur Apr 1, 2024
43a7558
chore: integrate sitemap and robots using next-sitempas
urmauur Apr 1, 2024
589f6cd
chore: update wall of love docs using from component homepage
urmauur Apr 1, 2024
8779ed5
chore: conditional if browser not chrom get single button download, a…
urmauur Apr 1, 2024
0da143c
chore: update title template
urmauur Apr 1, 2024
dc8ced5
chore: fix scalar issue theme
urmauur Apr 1, 2024
500d50b
chore: fix keep api-reference as new tab
urmauur Apr 1, 2024
846f5e9
chore: add hooks useIsomorphicLayout
urmauur Apr 1, 2024
f6e9779
chore: hide footer on api-reference since to avoid change theme
urmauur Apr 1, 2024
aa86eca
fix: Installation dropdown
hiro-v Apr 2, 2024
b90dd56
chore: add openapi json
urmauur Apr 2, 2024
942a995
chore: update readme
urmauur Apr 2, 2024
d041d16
chore: update content feature section
urmauur Apr 2, 2024
507052e
docs: Updated redirects file to fix broken link
aindrajaya Apr 2, 2024
76224cf
Merge branch 'feat/nextra' of github.com:janhq/docs into feat/nextra
aindrajaya Apr 2, 2024
aaf6d72
feat: initial setup nextra
urmauur Mar 26, 2024
4473572
chore: update blog layout and categories
urmauur Mar 26, 2024
d5c2ffc
chore: fix conflict
urmauur Mar 26, 2024
448d52c
chore: add package sharp for image production next
urmauur Mar 26, 2024
b626a06
chore: prepare integrate with google tag manager
urmauur Mar 26, 2024
4cee27d
chore: add banner homepage
urmauur Mar 26, 2024
c298e01
chore: added link url to release
urmauur Mar 26, 2024
a792e95
chore: add dummy result api when get rate limit
urmauur Mar 26, 2024
0a4a8ca
chore: cleanup light mode theme
urmauur Mar 26, 2024
7719dd8
chore: added banner link with new target
urmauur Mar 26, 2024
661bf07
chore: fix endpoint releases
urmauur Mar 26, 2024
702b670
chore: update types release changelog
urmauur Mar 26, 2024
f524190
chore: add dropdown download component
urmauur Mar 26, 2024
7c19cfe
chore: update step using nextra step component
urmauur Mar 27, 2024
581671f
chore: take a back features section
urmauur Mar 27, 2024
df55395
chore: update favicons
urmauur Mar 27, 2024
c206ac5
chore: preparing og image and some meta for SEO
urmauur Mar 27, 2024
8c070b0
Update CICD for nextra (#46)
hiento09 Mar 27, 2024
fd64b93
chore: remove specifiec refirect from next config
urmauur Mar 27, 2024
fa4e686
chore: fix title toolbar
urmauur Mar 27, 2024
d8ffd72
chore: fix issue api-reference
urmauur Mar 27, 2024
bdf79df
chore: tweak navbar menu display
urmauur Mar 28, 2024
6143453
chore: rename guides to documentation
urmauur Mar 28, 2024
7dd2ada
chore: fix responsive menu navbar
urmauur Mar 28, 2024
a28cd40
chore: update link from guides to docs
urmauur Mar 28, 2024
c57b353
chore: update thumbnail blog
urmauur Mar 28, 2024
c8b886e
chore: redirect missing url
urmauur Mar 28, 2024
8731865
docs: Rename extension
aindrajaya Mar 28, 2024
86f781f
docs: Update content and fix broken link in article
aindrajaya Mar 28, 2024
abcd362
docs: Update tabs and add image to Quickstart
aindrajaya Mar 28, 2024
dc3254a
docs: Fix meta.json for jan extensions
aindrajaya Mar 28, 2024
616d093
docs: Nextra setup redirect the broken link
aindrajaya Mar 28, 2024
8ad2a0d
docs: Delete redirects from next.config and create manual redirects
aindrajaya Mar 28, 2024
4566c42
chore: add section wall of love with carousel
urmauur Mar 28, 2024
3bf2e0e
chore: add plop js for create blog post via terminal
urmauur Mar 28, 2024
d602966
chore: remove max width of container tweet
urmauur Mar 28, 2024
cc0bd01
chore: update markdown quickstart using bas instead brew codeblock
urmauur Mar 28, 2024
8991696
chore: temporary fix scalar conflict theme with nextra
urmauur Mar 28, 2024
ff67c4c
feat: Jan desktop and server guide
hiro-v Mar 29, 2024
e770b9a
chore: update missing categories
urmauur Mar 29, 2024
1214ce1
chore: update fix clickable banner release
urmauur Mar 29, 2024
459aa76
chore: fix conflict
urmauur Apr 1, 2024
6c524c2
chore: added step on docs dekstop
urmauur Apr 1, 2024
433c1a2
chore: wip update new section
urmauur Apr 1, 2024
ed8e244
chore: update section social media card and update huggingface
urmauur Apr 1, 2024
4972cf8
chore: update total downloaded user
urmauur Apr 1, 2024
cfc6685
chore: update api structure section
urmauur Apr 1, 2024
49fd059
chore: added download page
urmauur Apr 1, 2024
0eb5652
Add _redirects file and change CI to deploy cloudflare (#65)
hiento09 Apr 1, 2024
16c1ede
docs: Reformat the inferences (engines) folder
aindrajaya Apr 1, 2024
1d13aef
docs: Update about section
aindrajaya Apr 1, 2024
e6f985e
docs: Updated the docs content and add assistans, models and quicstar…
aindrajaya Apr 1, 2024
456e3ef
chore: update edirect
urmauur Apr 1, 2024
23fc4b6
chore: update redirect
urmauur Apr 1, 2024
cbaa3a6
chore: update small improvement ui
urmauur Apr 1, 2024
623a270
chore: add robot txt
urmauur Apr 1, 2024
6a9edc8
chore: integrate sitemap and robots using next-sitempas
urmauur Apr 1, 2024
1cd83da
chore: update wall of love docs using from component homepage
urmauur Apr 1, 2024
efd62d3
chore: conditional if browser not chrom get single button download, a…
urmauur Apr 1, 2024
8056e75
chore: update title template
urmauur Apr 1, 2024
c2e2386
chore: fix scalar issue theme
urmauur Apr 1, 2024
bef6077
chore: fix keep api-reference as new tab
urmauur Apr 1, 2024
cc2aaff
chore: add hooks useIsomorphicLayout
urmauur Apr 1, 2024
3d339c1
chore: hide footer on api-reference since to avoid change theme
urmauur Apr 1, 2024
2707972
fix: Installation dropdown
hiro-v Apr 2, 2024
132cd8a
chore: add openapi json
urmauur Apr 2, 2024
0e0f5c8
chore: update readme
urmauur Apr 2, 2024
ba78064
docs: Updated redirects file to fix broken link
aindrajaya Apr 2, 2024
1b54807
chore: update content feature section
urmauur Apr 2, 2024
ea36d6e
chore: wip theme video
urmauur Apr 2, 2024
20173a4
chore: make theme component video and update og:image
urmauur Apr 2, 2024
7fef3b9
chore: update use tools
urmauur Apr 2, 2024
79e9268
chore: update featuire section homepage
urmauur Apr 2, 2024
fdcd859
chore: move draft pr to nextra branch
urmauur Apr 2, 2024
0f25f7d
chore: move authors yml
urmauur Apr 2, 2024
03db291
docs: updated about section by adding vision content
aindrajaya Apr 2, 2024
f94c41a
docs: Updated use tools content
aindrajaya Apr 2, 2024
fe36e3e
Merge branch 'feat/nextra' of github.com:janhq/docs into feat/nextra
aindrajaya Apr 2, 2024
3fc4e09
docs: remove vision section
aindrajaya Apr 2, 2024
1da5736
chore: update image features section
urmauur Apr 2, 2024
46aeda0
chore: update content and show changlog on navbar
urmauur Apr 3, 2024
43c151a
chore: fix description blog page
urmauur Apr 3, 2024
177c051
docs: Remove developer menu on footer
aindrajaya Apr 3, 2024
f77a93b
docs: Refactoring the docs based on feedbacks
aindrajaya Apr 3, 2024
5870af2
chore: missing url inference local lmstudio
urmauur Apr 3, 2024
ccf29c2
docs: Refactoring the docs based on feedbacks
aindrajaya Apr 3, 2024
482442f
Merge branch 'feat/nextra' of github.com:janhq/docs into feat/nextra
aindrajaya Apr 3, 2024
fe49263
Update index.mdx
eckartal Apr 3, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .env
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
GTM_ID=xxxx
4 changes: 1 addition & 3 deletions .env.example
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
GTM_ID=xxxx
ALGOLIA_API_KEY=xxxx
ALGOLIA_APP_ID=xxxx
GTM_ID=xxxx
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"
}
33 changes: 11 additions & 22 deletions .github/workflows/jan-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ on:
branches:
- main
pull_request:
branches:
- main
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

Expand Down Expand Up @@ -47,7 +45,7 @@ jobs:
- name: Install dependencies
run: yarn install
- name: Build website
run: sed -i '/process.env.DEBUG = namespaces;/c\// process.env.DEBUG = namespaces;' ./node_modules/debug/src/node.js && yarn build
run: export NODE_ENV=production && yarn build && cp _redirects out/_redirects

- name: Publish to Cloudflare Pages PR Preview and Staging
if: github.event_name == 'pull_request'
Expand All @@ -56,7 +54,7 @@ jobs:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
projectName: ${{ env.CLOUDFLARE_PROJECT_NAME }}
directory: ./build
directory: ./out
# Optional: Enable this if you want to have GitHub Deployments triggered
gitHubToken: ${{ secrets.GITHUB_TOKEN }}
id: deployCloudflarePages
Expand All @@ -67,23 +65,14 @@ jobs:
message: |
Preview URL: ${{ steps.deployCloudflarePages.outputs.url }}

- name: Add Custome Domain file
- name: Publish to Cloudflare Pages Production
if: github.event_name == 'push' && github.ref == 'refs/heads/main' && github.event.pull_request.head.repo.full_name != github.repository
run: echo "${{ vars.DOCUSAURUS_DOMAIN }}" > ./build/CNAME

# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
- name: Deploy to GitHub Pages
if: github.event_name == 'push' && github.ref == 'refs/heads/main' && github.event.pull_request.head.repo.full_name != github.repository
uses: peaceiris/actions-gh-pages@v3
uses: cloudflare/pages-action@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
publish_dir: ./build
# The following lines assign commit authorship to the official
# GH-Actions bot for deploys to `gh-pages` branch:
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
# The GH actions bot is used by default if you didn't specify the two fields.
# You can swap them out with your own user credentials.
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
projectName: ${{ env.CLOUDFLARE_PROJECT_NAME }}
directory: ./out
branch: main
# Optional: Enable this if you want to have GitHub Deployments triggered
gitHubToken: ${{ secrets.GITHUB_TOKEN }}
39 changes: 28 additions & 11 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,20 +1,37 @@
# Dependencies
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js
.yarn/install-state.gz

# Production
/build
# 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*

# local env files
.env*.local
.env

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts
5 changes: 5 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.next/
node_modules/
dist/
*.mdx
*.hbs
7 changes: 7 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"semi": false,
"singleQuote": true,
"quoteProps": "consistent",
"trailingComma": "es5",
"endOfLine": "auto"
}
26 changes: 3 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Website & Docs

This website is built using [Docusaurus 3.0](https://docusaurus.io/), a modern static website generator.
This website is built using [Nextra](https://nextra.site/), a modern static website generator.

### Information Architecture

Expand All @@ -16,19 +16,6 @@ We try to **keep routes consistent** to maintain SEO.

- **`/blog/`**: A blog for the Jan application.

### Sidebar Autogeneration

The order of each page is either explicitly defined in `sidebar.js` or follows the [Docusaurus autogenerated](https://docusaurus.io/docs/next/sidebar/autogenerated) naming format, `##-path-name.md`.

Important slugs are hardcoded at the document level (and shouldn't be rerouted):

```
---
title: Overview
slug: /docs
---
```

## How to Contribute

Refer to the [Contributing Guide](https://github.com/janhq/jan/blob/main/CONTRIBUTING.md) for more comprehensive information on how to contribute to the Jan project.
Expand All @@ -43,7 +30,7 @@ Refer to the [Contributing Guide](https://github.com/janhq/jan/blob/main/CONTRIB
```bash
cd jan/docs
yarn install
yarn start
yarn dev
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Expand Down Expand Up @@ -76,11 +63,4 @@ If you are using GitHub pages for hosting, this command is a convenient way to b

- When a pull request is created, the preview URL will be automatically commented on the pull request.

- The documentation will then be published to [https://dev.jan.ai/](https://dev.jan.ai/) when the pull request is merged to `dev`.

- Our open-source maintainers will sync the updated content from `dev` to `docs` branch, which will then be published to [https://jan.ai/](https://jan.ai/).

### Additional Plugins

- @docusaurus/theme-live-codeblock
- [Redocusaurus](https://redocusaurus.vercel.app/): manually upload swagger files at `/openapi/jan.yaml` to update the API reference documentation.
- The documentation will then be published to [https://jan.ai/](https://jan.ai/) when the pull request is merged to `main`.
Loading
Loading