-
Images should be upoaded to https://www.matterhackers.com/admin/images/. All images sholud be scaled to 640 wide to fit the expected theme.
- Log in to GitHub with your account
- Fork the repository to make your own copy
- Download the repository to your computer using SourceTree
- Edit content on your local filesytem in the cloned repository using Visual Studio Code
- Commit your changes locally
- Push to your remote fork
- Issue a pull request from your fork
MatterControl 1.7 articles have been imported and converted to Markdown from http://wiki.mattercontrol.com. You can find the converted documents at https://github.com/jlewin/mc-docs/tree/master/docs. There are many ways to import a given article but we'll choose the web workflow to start:
- Open an article from jlewin/mc-docs
- Click the Edit icon as depicted in the instructions above
- Copy the Markdown text to the clipboard
- Return to this repository and create a new document for the content
- Type the full path to the location where the new file will be. Missing path steps will get new folders created for them.
- Paste the Markdown text from the clipboard into the new document
- Click the
Commit New File
button to save your changes and start or continue a pull request
This is the short-term procedure required for success. Long term we need to resolve the Wyam/worktree conflicts and script this as part of deploy/build cake task
- Open PowerShell
- Change to your MatterControl-Help repository
cd \source\mh-help
- Delete the
output
directory - Remove the worktree
git worktree prune
- Remove the local gh-pages branch
git branch -d gh-pages
- Fetch
git fetch --all
- Pull the latest content from the master branch
git pull upstream master
- Build Wyam
.\build.ps1 -t build
or.\tools\Wyam.1.4.1\tools\net462\Wyam.exe build
- Rename the output directory
mv output output_
- Map output directory to gh-pages worktree
git worktree add output gh-pages
- Delete existing content in the output worktree
- Copy the build output into the worktree
cp output_ output
- Create commit
cd output; git add --all; git commit -m "Latest docs"
- Push the content to your local repo and issue a new pull request
git push
Edit config.wyam to customize TOC generation