Skip to content

Update README.md #481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 13, 2024
Merged

Update README.md #481

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,38 +13,39 @@ The primary repository that this documents is [docassemble-AssemblyLine](https:/

## Contributing to the documentation

This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
Documentation is contained in a series of markdown files. The menu is contained in a file named `sidebar.js`.
This website is built using [Docusaurus](https://docusaurus.io/), a static website generator for documentation. Documentation is contained in a series of markdown files. The menu is contained in a file named `sidebar.js`.

You should have a local copy of node.js and npm installed to edit the documentation.
If you want to contribute, please follow the [LIT Lab style guide](https://github.com/SuffolkLITLab/styleguide). When you submit a pull request with your changes, request a review from one or more [LIT Lab staff members](https://github.com/orgs/SuffolkLITLab/teams/lit-lab-staff).

### Installing
You will need to have a local copy of [node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed to edit the documentation.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is only if they want to see it before they submit the edit. People can just edit on GitHub, for example, to fix typos and other things that don't need complex formatting.


Make a clone of this repository and then type:
### Installing locally

Make a local clone of this repository, navigate to the repository in the terminal, and enter:

```console
npm install
```

### Build

This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Run locally

```console
npm run build
npm run start
```

### Run locally
This command runs `npm run build`, then starts a local development server and opens up the documentation website in a browser window. Most changes are reflected live without having to refresh the page or restart the server.

### Build

This command runs `npm run build`, then starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server:
This command generates static content in the **build** directory that can be served using any static contents hosting service.

```console
npm run start
npm run build
```

### Deploy

We use GitHub pages for deployment. Use the command below to deploy the repository to the gh-pages branch. It will then [go live](https://assemblyline.suffolklitlab.org/).
We use GitHub pages for deployment. Use the command below to deploy the repository to the gh-pages branch. It will then go live at [asssemblyline.suffolklitlab.org](https://assemblyline.suffolklitlab.org/).

```console
GIT_USER=<Your GitHub username> USE_SSH=TRUE npm run deploy
Expand Down
Loading