Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
- Included link to `How to Contribute to the Wiki` page.
- Clarified Docker instructions.
  • Loading branch information
vraer authored Oct 17, 2023
1 parent ac28c34 commit fca022b
Showing 1 changed file with 64 additions and 17 deletions.
81 changes: 64 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,79 @@

# HackforLA.org Wiki

This repository contains documentation for the Hack for LA website team. The site is live at [https://hackforla.github.io/website-wiki/](https://hackforla.github.io/website-wiki/) and is generated using [MkDocs](https://www.mkdocs.org/) with the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme.
This repository houses the documentation for the Hack for LA website team. The live site is available at [https://hackforla.github.io/website-wiki/](https://hackforla.github.io/website-wiki/). The documentation is built using [MkDocs](https://www.mkdocs.org/) and is styled with the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme.

**Note**: Issues related to this wiki are tracked in the [hackforla/website repository](https://github.com/hackforla/website). For more information on the current state of the wiki, please refer to the [How to Contribute to the Wiki](https://github.com/hackforla/website/wiki/How-to-Contribute-to-the-Wiki) page.

---

## Getting Started

### Clone or Fork the Repository

Clone your fork or the original repository locally:

```bash
git clone https://github.com/YOUR_USERNAME/website-wiki.git
cd website-wiki
```

## Installation

### With Docker

The quickest way to run the site is using Docker:
1. **Pull the Docker Image**: To ensure you have the latest Docker image, run:

``` bash
docker pull vraer/hfla-website-wiki:latest
docker run -p 8000:8000 vraer/hfla-website-wiki:latest
```
```bash
docker pull vraer/hfla-website-wiki:latest
```

2. **Start the Development Server**: To start the development server, run:

The site will now be running at <http://localhost:8000>.
```bash
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs vraer/hfla-website-wiki:latest
```

### With Python virtualenv
Your site will now be accessible at <http://localhost:8000>.

#### Building the Documentation

Alternatively, you can install locally using Python:
To build the documentation into a `site` folder, run:

``` python
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
mkdocs serve
```bash
docker run --rm -it -v ${PWD}:/docs vraer/hfla-website-wiki:latest build
```

## Support
### With Python virtualenv

1. **Create a Virtual Environment**:

```python
python3 -m venv venv
```

2. **Activate the Virtual Environment**:

```bash
source venv/bin/activate
```

3. **Install Required Packages**:

```bash
pip install -r requirements.txt
```

4. **Start the Development Server**:

```bash
mkdocs serve
```

5. **Build the Documentation**:

```bash
mkdocs build
```

Your site will now be accessible at <http://localhost:8000>.

If you need help or have questions, don't hesitate to reach out to the project maintainers or the Hack for LA community. You can also check the issues in the [hackforla/website](https://github.com/hackforla/website) repository for ongoing discussions and known issues.

0 comments on commit fca022b

Please sign in to comment.