Skip to content

Commit

Permalink
docs(website): contributing for Windows (#140)
Browse files Browse the repository at this point in the history
  • Loading branch information
trilowy authored Mar 17, 2024
1 parent cb74782 commit e9e8ea8
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions www/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Contributing to the Ergo‑L website

## Setup

### For Windows

* Open a terminal, for example Windows PowerShell
* Install [Hugo](https://gohugo.io/installation/windows/) :
```powershell
winget install Hugo.Hugo.Extended
```
* Optional if you run Hugo in a Linux terminal such as WSL or Git Bash ; install [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.4) (Hugo can’t run in preinstalled Windows PowerShell) :
```powershell
winget install --id Microsoft.Powershell --source winget
```
Note : PowerShell is not [the same application](https://learn.microsoft.com/en-us/powershell/scripting/whats-new/differences-from-windows-powershell?view=powershell-7.3) as _Windows_ PowerShell even if the name is almost the same and they are both maintained by Microsoft
* Install [Pandoc](https://pandoc.org/installing.html#windows) :
```powershell
winget install --source winget --exact --id JohnMacFarlane.Pandoc
```
* Launch the newly installed PowerShell (or restart it if you already had it) and go to the `www` folder :
```powershell
cd www
```
* Run the development server :
```powershell
hugo server
```
* And go to http://localhost:1313/ to see the effect of your changes in livereload

0 comments on commit e9e8ea8

Please sign in to comment.