Skip to content

Commit 43f0866

Browse files
committed
Add files for documentation
1 parent 5a86a54 commit 43f0866

File tree

11 files changed

+18760
-0
lines changed

11 files changed

+18760
-0
lines changed

.github/dependabot.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "npm"
9+
directory: "/website"
10+
schedule:
11+
interval: "weekly"
12+
groups:
13+
docusaurus:
14+
patterns:
15+
- "@docusaurus/*"
16+
react:
17+
patterns:
18+
- "react*"
19+
- package-ecosystem: "github-actions"
20+
# Don't need to specify `/.github/workflows` for `directory`. Github knows it.
21+
directory: "/"
22+
schedule:
23+
interval: "weekly"

website/.gitignore

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

website/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Website
2+
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4+
5+
### Installation
6+
7+
```
8+
$ yarn
9+
```
10+
11+
### Local Development
12+
13+
```
14+
$ yarn start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
### Build
20+
21+
```
22+
$ yarn build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
### Deployment
28+
29+
Using SSH:
30+
31+
```
32+
$ USE_SSH=true yarn deploy
33+
```
34+
35+
Not using SSH:
36+
37+
```
38+
$ GIT_USER=<Your GitHub username> yarn deploy
39+
```
40+
41+
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.

website/babel.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
3+
};

website/docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Hello World

website/docusaurus.config.ts

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
import type * as Preset from "@docusaurus/preset-classic";
2+
import type { Config } from "@docusaurus/types";
3+
4+
import { themes as prismThemes } from "prism-react-renderer";
5+
6+
const config: Config = {
7+
title: "<projectName> Documentation",
8+
favicon: "images/<your logo>.png",
9+
10+
// Set the production url of your site here
11+
url: "https://sassoftware.github.io",
12+
// Set the /<baseUrl>/ pathname under which your site is served
13+
// For GitHub pages deployment, it is often '/<projectName>/'
14+
baseUrl: "/<projectName>/",
15+
16+
// GitHub pages deployment config.
17+
// If you aren't using GitHub pages, you don't need these.
18+
organizationName: "sassoftware", // Usually your GitHub org/user name.
19+
projectName: "<projectName>", // Usually your repo name.
20+
21+
onBrokenLinks: "throw",
22+
onBrokenMarkdownLinks: "throw",
23+
24+
// Even if you don't use internationalization, you can use this field to set
25+
// useful metadata like html lang. For example, if your site is Chinese, you
26+
// may want to replace "en" with "zh-Hans".
27+
i18n: {
28+
defaultLocale: "en",
29+
locales: ["en"],
30+
},
31+
32+
presets: [
33+
[
34+
"classic",
35+
{
36+
docs: {
37+
routeBasePath: "/",
38+
// Remove this to remove the "edit this page" links.
39+
editUrl:
40+
"https://github.com/sassoftware/<projectName>/tree/main/website/",
41+
},
42+
blog: false,
43+
theme: {
44+
customCss: ["./src/css/custom.css"],
45+
},
46+
} satisfies Preset.Options,
47+
],
48+
],
49+
50+
themeConfig: {
51+
docs: {
52+
sidebar: {
53+
hideable: true,
54+
},
55+
},
56+
navbar: {
57+
title: "<projectName> Documentation",
58+
logo: {
59+
alt: "SAS",
60+
src: "images/<your logo>.png",
61+
},
62+
items: [
63+
{
64+
href: "https://github.com/sassoftware/<projectName>",
65+
className: "header-github-link",
66+
title: "GitHub repository",
67+
position: "right",
68+
},
69+
],
70+
},
71+
footer: {
72+
style: "dark",
73+
links: [
74+
{
75+
title: "Support",
76+
items: [
77+
{
78+
label: "GitHub Repository",
79+
href: "https://github.com/sassoftware/<projectName>",
80+
},
81+
],
82+
},
83+
],
84+
copyright: `Copyright © ${new Date().getFullYear()}, SAS Institute Inc., Cary, NC, USA. All Rights Reserved. Built with Docusaurus.`,
85+
},
86+
prism: {
87+
theme: prismThemes.github,
88+
darkTheme: prismThemes.dracula,
89+
// uncomment below to add language support
90+
// additionalLanguages: ["bash", "json"],
91+
},
92+
} satisfies Preset.ThemeConfig,
93+
94+
// uncomment below for mermaid support
95+
// markdown: {
96+
// mermaid: true,
97+
// },
98+
99+
themes: [
100+
[
101+
"@easyops-cn/docusaurus-search-local",
102+
{
103+
docsRouteBasePath: "/",
104+
explicitSearchResultPath: true,
105+
hashed: true,
106+
highlightSearchTermsOnTargetPage: true,
107+
},
108+
],
109+
// uncomment below for mermaid support
110+
// "@docusaurus/theme-mermaid",
111+
],
112+
};
113+
114+
export default config;

0 commit comments

Comments
 (0)