Website for awesome WM
This is the main source of the website for the awesome window manager.
You can build the web page locally by running
make, which will generate the
To view it, open
html/index.html in your web browser.
You can simulate running a web server using Python, which will automatically
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
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
Link your page to the right section in the
recipes.mdwnpage with Markdown syntax.
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.