Skip to content

Commit 66d8c7b

Browse files
docs: Ported docs here from the other repo
Ref: python-thread/thread.ngjx.org#59 Closes: #89
1 parent 4ca4684 commit 66d8c7b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+17144
-0
lines changed

docs/.eslintrc.json

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"root": true,
3+
"extends": [
4+
"next/core-web-vitals",
5+
"plugin:mdx/recommended"
6+
],
7+
"settings": {
8+
"mdx/code-blocks": true
9+
},
10+
"overrides": [
11+
{
12+
"files": [
13+
"*.md",
14+
"*.mdx"
15+
],
16+
"parser": "eslint-mdx"
17+
}
18+
]
19+
}

docs/.gitignore

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/.pnp
6+
.pnp.js
7+
.yarn/install-state.gz
8+
9+
# testing
10+
/coverage
11+
12+
# next.js
13+
/.next/
14+
/out/
15+
16+
# production
17+
/build
18+
19+
# misc
20+
.DS_Store
21+
*.pem
22+
23+
# debug
24+
npm-debug.log*
25+
yarn-debug.log*
26+
yarn-error.log*
27+
28+
# local env files
29+
.env*.local
30+
31+
# vercel
32+
.vercel
33+
34+
# typescript
35+
*.tsbuildinfo
36+
next-env.d.ts

docs/LICENSE

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
BSD 3-Clause License
2+
3+
Copyright (c) 2023, Jun Xiang
4+
5+
Redistribution and use in source and binary forms, with or without
6+
modification, are permitted provided that the following conditions are met:
7+
8+
1. Redistributions of source code must retain the above copyright notice, this
9+
list of conditions and the following disclaimer.
10+
11+
2. Redistributions in binary form must reproduce the above copyright notice,
12+
this list of conditions and the following disclaimer in the documentation
13+
and/or other materials provided with the distribution.
14+
15+
3. Neither the name of the copyright holder nor the names of its
16+
contributors may be used to endorse or promote products derived from
17+
this software without specific prior written permission.
18+
19+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

docs/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# [Thread Documentation Website](https://thread.ngjx.org)
2+
3+
Currently work in progress, please be patient!

docs/next-sitemap.config.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
/** @type {import('next-sitemap').IConfig} */
2+
module.exports = {
3+
siteUrl: process.env.NODE_ENV === 'production' ? 'https://thread.ngjx.org' : 'http://localhost:3000',
4+
generateRobotsTxt: true, // (optional)
5+
// ...other options
6+
}

docs/next.config.js

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
/** @type {import('nextra').withNextra} */
2+
const withNextra = require('nextra')({
3+
theme: 'nextra-theme-docs',
4+
themeConfig: './theme.config.tsx',
5+
defaultShowCopyCode: true,
6+
latex: true,
7+
})
8+
9+
/** @type {import('next').NextConfig} */
10+
const NextConfig = {
11+
images: {
12+
remotePatterns: [{
13+
protocol: 'https',
14+
hostname: 'avatars.githubusercontent.com',
15+
pathname: '/u/*'
16+
}]
17+
},
18+
redirects: async () => ([
19+
{
20+
source: '/docs/v2:any?/:path*',
21+
destination: '/docs/latest/:path*',
22+
permanent: false
23+
},
24+
{
25+
source: '/docs/v:major.:minor.:patch/:path*',
26+
destination: '/docs/v:major/:path*',
27+
permanent: true
28+
},
29+
{
30+
source: '/github/v:major.:minor.:patch/:path*',
31+
destination: 'https://github.com/python-thread/thread/releases/tag/v:major.:minor.:patch',
32+
permanent: true
33+
}
34+
])
35+
}
36+
37+
module.exports = withNextra(NextConfig)

0 commit comments

Comments
 (0)