mirror of
https://github.com/yangshun/tech-interview-handbook.git
synced 2025-07-31 22:24:59 +08:00
website: move into monorepo
This commit is contained in:
40
apps/website/README.md
Executable file
40
apps/website/README.md
Executable file
@ -0,0 +1,40 @@
|
|||||||
|
# Website
|
||||||
|
|
||||||
|
This website is built using Docusaurus 2, a modern static website generator. It is part of a [Turborepo](https://turborepo.org/) monorepo setup.
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
|
||||||
|
We use Yarn 1 as the package manager. At the root of the repository, run `yarn` to install the monorepo dependencies.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ yarn
|
||||||
|
```
|
||||||
|
|
||||||
|
### Local Development
|
||||||
|
|
||||||
|
Also at the root of the repository, run:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ yarn dev:website
|
||||||
|
```
|
||||||
|
|
||||||
|
This command starts a local development server and opens up a browser window. Most changes made to JavaScript and Markdown files will be reflected instantly without having to restart the server.
|
||||||
|
|
||||||
|
### Build
|
||||||
|
|
||||||
|
Navigate to the `apps/website` directory.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cd apps/website
|
||||||
|
$ yarn build
|
||||||
|
```
|
||||||
|
|
||||||
|
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
||||||
|
|
||||||
|
### Deployment
|
||||||
|
|
||||||
|
```
|
||||||
|
$ GIT_USER=<Your GitHub username> USE_SSH=1 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.
|
@ -196,7 +196,7 @@ module.exports = {
|
|||||||
'@docusaurus/preset-classic',
|
'@docusaurus/preset-classic',
|
||||||
{
|
{
|
||||||
docs: {
|
docs: {
|
||||||
path: '../contents',
|
path: './contents',
|
||||||
routeBasePath: '/',
|
routeBasePath: '/',
|
||||||
sidebarPath: require.resolve('./sidebars.js'),
|
sidebarPath: require.resolve('./sidebars.js'),
|
||||||
// showLastUpdateAuthor: true,
|
// showLastUpdateAuthor: true,
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user