update docs
This commit is contained in:
parent
376f287245
commit
9bdc2c18ff
|
@ -1,3 +1,5 @@
|
|||
// WIP need to update this
|
||||
|
||||
## Content Formatting Documentation
|
||||
|
||||
All modules are written in [Markdown](https://www.markdownguide.org/cheat-sheet/). There are special additions to the markdown that we have added to this site.
|
||||
|
|
19
Front End Documentation.md
Normal file
19
Front End Documentation.md
Normal file
|
@ -0,0 +1,19 @@
|
|||
# Front End Documentation
|
||||
|
||||
If you are familiar with Gatsby development, just run `yarn install` and `yarn develop` to get started.
|
||||
|
||||
## Quickstart
|
||||
|
||||
The following is written for individuals without front-end development experience.
|
||||
|
||||
1. Set up your development environment.
|
||||
- Install [node.js](https://nodejs.org/en/)
|
||||
- Gatsby docs: https://www.gatsbyjs.org/tutorial/part-zero/#install-nodejs-for-your-appropriate-operating-system
|
||||
- Install [yarn](https://classic.yarnpkg.com/en/)
|
||||
- `npm install -g yarn`? might work
|
||||
2. Clone repo
|
||||
- `git clone https://github.com/thecodingwizard/usaco-guide.git`
|
||||
3. Install Dependencies
|
||||
- `yarn install`
|
||||
4. Run development server
|
||||
- `yarn develop`
|
|
@ -9,7 +9,8 @@ As much as possible, please try to keep the markdown files independent of the fr
|
|||
|
||||
## Documentation
|
||||
|
||||
Refer to "Content Documentation.md" for more info.
|
||||
- To get this site running locally, refer to the [Front End Documentation](Front%20End%20Documentation.md).
|
||||
- For information regarding Content Writing, refer to the [Content Documentation](Content%20Documentation.md).
|
||||
|
||||
## Tech Stack
|
||||
|
||||
|
|
Reference in a new issue