Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ianschmitz committed Mar 24, 2020
1 parent ed6344a commit c9ac7f3
Showing 1 changed file with 10 additions and 20 deletions.
30 changes: 10 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,25 @@
# Geocortex Developer Center

The home base for all developer center geocortex documentation.

This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
This is the source for the Geocortex Developer Center website; feel free to suggest changes to our docs!

## Contributing

This documentation is an open source project, and you are encouraged to submit issues or pull requests for improvements or bug fixes if you notice them!

### To the Docs

TODO
This documentation is an open source project, and you are encouraged to submit issues or pull requests for improvements or bug fixes if you notice them.

### To the code
You might want to make yourself familiar with [Docusaurus v2](https://v2.docusaurus.io/) to make significant changes to the website. If you only want to make content changes you will find the page source within the `docs` folder.

TODO
### Setup

#### Installation
#### Install dependencies

```
$ yarn
```
`yarn` or `npm install`

#### Local Development
#### Start development server

```
$ yarn start
```
`yarn start` or `npm start`

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

#### Deployment
#### Deploy

The website is deployed to github pages whenever there is a commit to master. TODO this is currently a lie
The website is automatically built and deployed on commit to master.

0 comments on commit c9ac7f3

Please sign in to comment.