https://github.com/torproject/dev
Tor dev website
https://github.com/torproject/dev
Last synced: about 1 year ago
JSON representation
Tor dev website
- Host: GitHub
- URL: https://github.com/torproject/dev
- Owner: torproject
- License: mit
- Created: 2020-01-16T17:41:41.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-08-08T22:55:37.000Z (almost 2 years ago)
- Last Synced: 2025-02-14T17:17:27.491Z (over 1 year ago)
- Language: SCSS
- Size: 28.8 MB
- Stars: 4
- Watchers: 6
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Tor Dev Portal
The [Tor Dev Portal](https://docs.torproject.org) is built using the [Hugo](https://gohugo.io) Static Site Generator.
To edit the website locally, we have to install Hugo Extended version and a text editor.
## How to install
The actual setup use `npm` to provide all the libraries you need to develop the website and Hugo itself.
### Installing node / npm
Debian: `apt install nodejs`
arch: `pacman -S nodejs`
On mac using homebrew: `brew install node`
### Installing hugo and other dependencies
Once node is installed, you can install the dependencies with the following command `npm install`.
To run the application locally you can run `nom run server`
## Local testing
To run a local version of the website, we have to run the following command inside the root path of the website.
`npm run server -- --environment production`
The `--environment` argument is necessary for us to be able to render the content in the same way that the public version would come out to be.
With this we're ready to start editing the files.
## Docs
For further changes and customization, refer to the [Hugo docs](https://gohugo.io/documentation/).