Merge pull request #59 from aajjbb/recipes-docs

Adding a guide on how to contribute to the recipes section
This commit is contained in:
Daniel Hahler 2017-01-20 19:45:47 +01:00 committed by GitHub
commit 32e277d9f5
2 changed files with 31 additions and 0 deletions

View File

@ -24,6 +24,33 @@ open `index.html` when following a link to a directory:
$ cd html $ cd html
$ python3 -m http.server -b localhost 8000 & $ python3 -m http.server -b localhost 8000 &
## Contributing to Recipes Section
1. Fork this repository and create a new branch with a name relevant to the information you will be adding to the site.
If you have doubts in how to Fork and Branch, take a look in this cheat-sheet [here](https://www.git-tower.com/blog/git-cheat-sheet/)
The process of editing files can be done inside GitHub's interface, more information [here](https://help.github.com/articles/github-flow/)
#### With external Link
1. Create a new link in markdown format `[Link Name](Real Link)` in the appropiated section in `recipes.mdwn` file.
#### With internal Link (host in awesome site)
1. Create a new page with your tutorial/setup/widget/snippet in Markdown, with a relevant name, under the `recipes` folder.
- Example `recipes/xrandr-tutorial.mdmw`
2. Link your page to the right section in the `recipes.mdwn` page with Markdown syntax.
- Example `[XrandR Tutorial](../recipes/xrandr-tutorial.html)`
#### Seeing results and pulling your changes
1. Build the site as explaining in the Hacking section in this same page to check how your changes will looks like.
2. If everything is right and looks good, you're ready do make a Pull Request.
## Publishing ## Publishing
The master branch gets built by The master branch gets built by

View File

@ -2,6 +2,10 @@
The recipes section is where you can find useful snippets and tutorials on how to improve your Awesome setup. The recipes section is where you can find useful snippets and tutorials on how to improve your Awesome setup.
* [How to contribute to Recipes](https://github.com/awesomeWM/awesome-www#contributing-to-recipes-section)
## Setups
* [My First Awesome Setup](https://awesomewm.org/apidoc/documentation/07-my-first-awesome.md.html#) * [My First Awesome Setup](https://awesomewm.org/apidoc/documentation/07-my-first-awesome.md.html#)
## Widgets ## Widgets