Skip to content

Commit

Permalink
Updated README to include information on converting markdown files to…
Browse files Browse the repository at this point in the history
… pug and keeping the template layout and how to update GitHub pages through the master branch
  • Loading branch information
TravisH18 committed Oct 11, 2024
1 parent 3ec76dd commit 106d24a
Showing 1 changed file with 53 additions and 5 deletions.
58 changes: 53 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# New VELMA 2.2 Documentation
# New VELMA 2.2 Documentation

Process
This is the develop branch for the VELMA documentation GitHub Pages website.

- Files that will be compiled to static .html pages should be placed in the /views directory
- Run the npm run build command to compile .html pages
- GitHub actions will
## Background

- PDF documentation were converted to .pug files and placed in the /views directory
- Run the `npm run build` command to compile .html pages

Run dev server with the following command to view .pug files in a local host

Expand All @@ -17,3 +18,50 @@ To turn .pug files into html simply run the following line:
```
node ./htmlify.js
```

## Converting Markdown files to pug

1. Place .md file that you want to convert into the views/markdown directory
2. Run the md_to_pug.js script

Either of these commands will work to run the script

`node md_to_pug.js`

`npm run md-to-pug`

## Pushing changes to GitHub Pages

Once you have made a change that alters the `docs` directory and want to update the GitHub Pages with this change here are the steps you need to take.

### Push changes from develop branch to GitHub

On develop branch run these commands:

```
git add .
git commit -m "{insert change description here}"
git push
```

### Switch to master branch

```
git checkout master
```

### Copy `docs` folder from develop to master

```
git checkout develop -- docs
```

### Push the docs folder to GitHub master branch

While still on the master branch run the following commands:

```
git add .\docs\
git commit -m "{insert change description here}"
git push
```

0 comments on commit 106d24a

Please sign in to comment.