Skip to content

Commit

Permalink
feat: docusaurus (#69)
Browse files Browse the repository at this point in the history
  • Loading branch information
PenPow authored Jul 29, 2023
1 parent 6eb24fa commit d1092ad
Show file tree
Hide file tree
Showing 32 changed files with 16,337 additions and 2 deletions.
3 changes: 2 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ node_modules/
./.eslintrc.cjs
./prettier.config.cjs
./commitlint.config.cjs
scripts/**/*
scripts/**/*
website/**/*
2 changes: 1 addition & 1 deletion .eslintrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ module.exports = {
"typescript": true
}
},
ignorePatterns: ["node_modules", ".eslintrc.cjs", "commitlint.config.js", "tsup.config.ts", "dist"],
ignorePatterns: ["node_modules", ".eslintrc.cjs", "commitlint.config.js", "tsup.config.ts", "dist", "website"],
env: {
node: true,
es2022: true,
Expand Down
Binary file added branding/SentryShieldOnly.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added branding/SentryShieldOnly.xcf
Binary file not shown.
20 changes: 20 additions & 0 deletions website/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
41 changes: 41 additions & 0 deletions website/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Website

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

### Installation

```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

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

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

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.
3 changes: 3 additions & 0 deletions website/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
Loading

0 comments on commit d1092ad

Please sign in to comment.