33506582c6
This code would have to check if unpack or table.unpack is the function to use. Instead of adding this check, this commit just removes the trivial use of unpack. Fixes: https://github.com/awesomeWM/awesome/issues/2802 Signed-off-by: Uli Schlachter <psychon@znc.in> |
||
|---|---|---|
| images | ||
| recipes | ||
| src@5da5d36178 | ||
| templates | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| Makefile | ||
| README.for_webpage.md | ||
| README.md | ||
| community.mdwn | ||
| doc.mdwn | ||
| doing_a_release.mdwn | ||
| download.mdwn | ||
| index.mdwn | ||
| local.css | ||
| recipes.mdwn | ||
| releases.mdwn | ||
| screenshots.mdwn | ||
README.md
Website for awesome WM
This is the main source of the website for the awesome window manager.
Requirements
- ikiwiki
- PerlMagick (optional, for images)
Hacking
You can build the web page locally by running make, which will generate the
output in html/.
To view it, open html/index.html in your web browser.
You can simulate running a web server using Python, which will automatically
open index.html when following a link to a directory:
cd html && python3 -m http.server -b localhost 8000 &
Contributing to the Screenshots Section
To contribute with Screenshots:
-
Add your image to the folder images/screenshots with an appropriate name.
-
Add a new
<figure>tag in the bottom of screenshots.mdwn, -
Inside the new tag, add the screenshots with a
<img>tag and use the<figcaption>to add caption to the image, explaining what is being used on the screenshot.
Contributing to Recipes Section
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
The process of editing files can be done inside GitHub's interface, more information here
With external Link
Create a new link in markdown format [Link Name](Real Link) in the appropriate
section in recipes.mdwn file.
With internal Link (host in awesome site)
-
Create a new page with your tutorial/setup/widget/snippet in Markdown, with a relevant name, under the
recipesfolder.Example
recipes/xrandr-tutorial.mdmw -
Link your page to the right section in the
recipes.mdwnpage with Markdown syntax.Example
[XrandR Tutorial](../recipes/xrandr-tutorial.html)
Seeing results and pulling your changes
-
Build the site as explained in the Hacking section in this same page to check how your changes will look like.
-
If everything is right and looks good, you're ready do make a Pull Request.
Publishing
The master branch gets built by Travis CI, and is then published through Github's Organization Pages.
Other resources
The API documentation for the master branch at /apidoc is viewable at Github's Project Pages for the apidoc repo, where it gets pushed to from successful builds in the awesome main repo.