larryh/corso
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
corso/website
History
Niraj Tolia 00103d9531
Add CF distribution id for Corso website (#1316) 
## Description

This allows us to automate website publishing

## Type of change

<!--- Please check the type of change your PR introduces: --->
- [x] 💻 CI/Deployment
2022-10-25 01:15:03 +00:00
..
src
Fix website links to docs (#1317)
2022-10-25 01:13:49 +00:00
Dockerfile
Option to not use docker for Makefile in docs/website (#1087)
2022-10-14 03:18:50 +00:00
gulpfile.js
Option to not use docker for Makefile in docs/website (#1087)
2022-10-14 03:18:50 +00:00
Makefile
Add CF distribution id for Corso website (#1316)
2022-10-25 01:15:03 +00:00
package.json
Corso website template + build framework (#723)
2022-09-02 00:03:10 +00:00
README.md
Add a website README (#737)
2022-09-02 15:25:18 +00:00
tailwind.config.js
Corso website template + build framework (#723)
2022-09-02 00:03:10 +00:00
yarn.lock
Corso website template + build framework (#723)
2022-09-02 00:03:10 +00:00

README.md

Corso website documentation

Requirements

Building the Corso website requires the following tools on your machine:

  • make
  • Docker

Installation

make buildimage

Live documentation development

make dev

This command starts a local development server within the Docker container and will expose a live website preview at http://localhost:3000.

Building a static website

make build

This command generates static content into the dist directory for integration with any static contents hosting service. If you are using AWS S3 + CloudFront, you can run make publish to upload to the configured S3 bucket.

Website platform development

make shell

Use this command to interactively (and temporarily!) change the contents or configuration of the live website container image (for example, when experimenting with new packages).