mirror of https://codeberg.org/pzp/pzp-wiki.git
Get deploy to work on codeberg
This commit is contained in:
parent
86cc6f6fbb
commit
59c026d4d8
18
README.md
18
README.md
|
@ -5,13 +5,13 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
|
|||
### Installation
|
||||
|
||||
```
|
||||
$ yarn
|
||||
$ npm i
|
||||
```
|
||||
|
||||
### Local Development
|
||||
|
||||
```
|
||||
$ yarn start
|
||||
$ npm 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.
|
||||
|
@ -19,23 +19,15 @@ This command starts a local development server and opens up a browser window. Mo
|
|||
### Build
|
||||
|
||||
```
|
||||
$ yarn build
|
||||
$ npm 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
|
||||
$ npm run 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.
|
||||
This builds and puts the built files into the `pages` branch and pushes it to codeberg which updates production.
|
||||
|
|
|
@ -18,8 +18,10 @@ const config = {
|
|||
|
||||
// GitHub pages deployment config.
|
||||
// If you aren't using GitHub pages, you don't need these.
|
||||
organizationName: 'staltz', // Usually your GitHub org/user name.
|
||||
organizationName: 'pzp', // Usually your GitHub org/user name.
|
||||
projectName: 'pzp-wiki', // Usually your repo name.
|
||||
deploymentBranch: 'pages',
|
||||
githubHost: 'codeberg.org',
|
||||
|
||||
onBrokenLinks: 'throw',
|
||||
onBrokenMarkdownLinks: 'warn',
|
||||
|
|
|
@ -17,7 +17,7 @@ function HomepageHeader() {
|
|||
<div className={styles.buttons}>
|
||||
<Link
|
||||
className="button button--secondary button--lg"
|
||||
to="/docs/intro">
|
||||
to="/guide/intro">
|
||||
Docusaurus Tutorial - 5min ⏱️
|
||||
</Link>
|
||||
</div>
|
||||
|
|
Loading…
Reference in New Issue