forked from CS2103JAN2018-F09-B1/main
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DeveloperGuide: add guide to convert docs to PDF
The documentation files are written in Markdown and published to GitHub pages. However, PDF versions of the docs may be required, such as for providing offline access to documentation files. Let's update the developer guide to teach developers to use Chrome's 'Save as PDF' option to convert the online documentation to PDF format. Chrome's 'Save as PDF' preserves the contents of HTML files well, including the hyperlinks, and is easy to use. Furthermore, Chrome is a commonly used web browser so developers are unlikely to have to install additional software.
- Loading branch information
Showing
4 changed files
with
76 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# Using GitHub Pages | ||
|
||
[GitHub Pages](https://pages.github.com/) is a static site hosting service that allows users to publish | ||
webpages using files in their GitHub repositories. | ||
|
||
## Setting Up | ||
|
||
GitHub Pages offers two kinds of sites: user/organization sites and project sites. | ||
Since we are using GitHub Pages to showcase the documentation for our project, we will be creating a project site. | ||
|
||
1. Navigate to the repository's `Settings` tab in GitHub. <br> | ||
<img src="images/github_repo_settings.png" width="600"> | ||
1. Under the GitHub Pages section, click `Choose a theme` in `Theme chooser`. Pick a theme for the | ||
project site and click `Select theme` when done. | ||
1. You can now view the site at `https://<username-or-organization-name>.github.io/<repo-name>`. <br> | ||
e.g. `https://se-edu.github.io/addressbook-level4` | ||
|
||
Note that the publishing source has been automatically set to `master branch`. | ||
This means that the GitHub Pages site will be published using source files in the `master` branch. | ||
Jekyll, a static site generator integrated with GitHub Pages, automatically renders Markdown files | ||
(in the `master` branch) to HTML, which are then deployed to the project site by GitHub Pages. | ||
|
||
## Viewing the Project Site | ||
|
||
The project site URL follows the format `https://<username-or-organization-name>.github.io/<repo-name>`, | ||
e.g. `https://se-edu.github.io/addressbook-level4`. | ||
By default, the [README](../README.md) file is displayed on this page. | ||
|
||
For the other pages, the structure of the site follows the structure of the repository. <br> | ||
For example, `docs/UserGuide.md` is published at `https://<username-or-organization-name>.github.io/addressbook-level4/docs/UserGuide.html`. | ||
|
||
## Updating the Project Site | ||
|
||
To update the project site, simply edit the documentation files in Markdown and push the changes to GitHub. | ||
GitHub Pages automatically updates the project site when changes are committed to the `master` branch | ||
(e.g. when the commit is pushed to the `master` branch or when the pull request containing the commit is | ||
merged into `master`). | ||
|
||
## Customizing the Project Site | ||
|
||
For instructions on customizing the project site, refer to [GitHub's guides](https://help.github.com/categories/customizing-github-pages/). | ||
|
||
## Troubleshooting | ||
|
||
**Problem: Markdown is not displayed properly in GitHub Pages even though they appear correctly in GitHub preview** | ||
|
||
* Reason: Jekyll (which converts Markdown to HTML for GitHub Pages) uses kramdown as its markdown engine but | ||
GitHub preview uses GitHub's own markdown engine. Since kramdown requires stricter syntax than GitHub's markdown | ||
engine, a Markdown file might be rendered correctly in GitHub preview but not on GitHub Pages. | ||
* Solution: Make sure you have followed the [coding standard](https://oss-generic.github.io/process/codingStandards/CodingStandard-Gfmd.html) | ||
for GitHub Flavored Markdown. If the problem persists, try checking [kramdown's syntax](https://kramdown.gettalong.org/parser/gfm.html) | ||
to see if you are using the correct syntax for GitHub Pages. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.