forked from nus-cs2103-AY2324S1/tp
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from nixonwidjaja/jekyll
Fix layout, convert to jekyll
- Loading branch information
Showing
56 changed files
with
1,309 additions
and
287 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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 was deleted.
Oops, something went wrong.
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 |
---|---|---|
@@ -1,8 +1,6 @@ | ||
--- | ||
layout: default.md | ||
title: "Configuration guide" | ||
layout: page | ||
title: Configuration guide | ||
--- | ||
|
||
# Configuration guide | ||
|
||
Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: `config.json`). |
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
Large diffs are not rendered by default.
Oops, something went wrong.
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 |
---|---|---|
@@ -1,21 +1,29 @@ | ||
--- | ||
layout: default.md | ||
title: "Documentation guide" | ||
pageNav: 3 | ||
layout: page | ||
title: Documentation guide | ||
--- | ||
|
||
# Documentation Guide | ||
**Setting up and maintaining the project website:** | ||
|
||
* We use [**Jekyll**](https://jekyllrb.com/) to manage documentation. | ||
* The `docs/` folder is used for documentation. | ||
* To learn how set it up and maintain the project website, follow the guide [_[se-edu/guides] **Using Jekyll for project documentation**_](https://se-education.org/guides/tutorials/jekyll.html). | ||
* Note these points when adapting the documentation to a different project/product: | ||
* The 'Site-wide settings' section of the page linked above has information on how to update site-wide elements such as the top navigation bar. | ||
* :bulb: In addition to updating content files, you might have to update the config files `docs\_config.yml` and `docs\_sass\minima\_base.scss` (which contains a reference to `AB-3` that comes into play when converting documentation pages to PDF format). | ||
* If you are using Intellij for editing documentation files, you can consider enabling 'soft wrapping' for `*.md` files, as explained in [_[se-edu/guides] **Intellij IDEA: Useful settings**_](https://se-education.org/guides/tutorials/intellijUsefulSettings.html#enabling-soft-wrapping) | ||
|
||
* We use [**MarkBind**](https://markbind.org/) to manage documentation. | ||
* The `docs/` folder contains the source files for the documentation website. | ||
* To learn how set it up and maintain the project website, follow the guide [[se-edu/guides] Working with Forked MarkBind sites](https://se-education.org/guides/tutorials/markbind-forked-sites.html) for project documentation. | ||
|
||
**Style guidance:** | ||
|
||
* Follow the [**_Google developer documentation style guide_**](https://developers.google.com/style). | ||
* Also relevant is the [_se-edu/guides **Markdown coding standard**_](https://se-education.org/guides/conventions/markdown.html). | ||
|
||
* Also relevant is the [_[se-edu/guides] **Markdown coding standard**_](https://se-education.org/guides/conventions/markdown.html) | ||
|
||
**Diagrams:** | ||
|
||
* See the [_[se-edu/guides] **Using PlantUML**_](https://se-education.org/guides/tutorials/plantUml.html) | ||
|
||
**Converting to PDF** | ||
**Converting a document to the PDF format:** | ||
|
||
* See the guide [_se-edu/guides **Saving web documents as PDF files**_](https://se-education.org/guides/tutorials/savingPdf.html). | ||
* See the guide [_[se-edu/guides] **Saving web documents as PDF files**_](https://se-education.org/guides/tutorials/savingPdf.html) |
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,10 @@ | ||
# frozen_string_literal: true | ||
|
||
source "https://rubygems.org" | ||
|
||
git_source(:github) {|repo_name| "https://github.com/#{repo_name}" } | ||
|
||
gem 'jekyll' | ||
gem 'github-pages', group: :jekyll_plugins | ||
gem 'wdm', '~> 0.1.0' if Gem.win_platform? | ||
gem 'webrick' |
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
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 |
---|---|---|
@@ -1,15 +1,12 @@ | ||
--- | ||
layout: default.md | ||
title: "User Guide" | ||
pageNav: 3 | ||
layout: page | ||
title: User Guide | ||
--- | ||
|
||
# AB-3 User Guide | ||
AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps. | ||
|
||
AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps. | ||
|
||
<!-- * Table of Contents --> | ||
<page-nav-print /> | ||
* Table of Contents | ||
{:toc} | ||
|
||
-------------------------------------------------------------------------------------------------------------------- | ||
|
||
|
@@ -44,9 +41,9 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo | |
|
||
## Features | ||
|
||
<box type="info" seamless> | ||
<div markdown="block" class="alert alert-info"> | ||
|
||
**Notes about the command format:**<br> | ||
**:information_source: Notes about the command format:**<br> | ||
|
||
* Words in `UPPER_CASE` are the parameters to be supplied by the user.<br> | ||
e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`. | ||
|
@@ -64,7 +61,7 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo | |
e.g. if the command specifies `help 123`, it will be interpreted as `help`. | ||
|
||
* If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application. | ||
</box> | ||
</div> | ||
|
||
### Viewing help : `help` | ||
|
||
|
@@ -81,10 +78,9 @@ Adds a person to the address book. | |
|
||
Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…` | ||
|
||
<box type="tip" seamless> | ||
|
||
**Tip:** A person can have any number of tags (including 0) | ||
</box> | ||
<div markdown="span" class="alert alert-primary">:bulb: **Tip:** | ||
A person can have any number of tags (including 0) | ||
</div> | ||
|
||
Examples: | ||
* `add n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01` | ||
|
@@ -165,11 +161,9 @@ AddressBook data are saved in the hard disk automatically after any command that | |
|
||
AddressBook data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file. | ||
|
||
<box type="warning" seamless> | ||
|
||
**Caution:** | ||
If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it. | ||
</box> | ||
<div markdown="span" class="alert alert-warning">:exclamation: **Caution:** | ||
If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it. | ||
</div> | ||
|
||
### Archiving data files `[coming in v2.0]` | ||
|
||
|
@@ -192,12 +186,12 @@ _Details coming soon ..._ | |
|
||
## Command summary | ||
|
||
Action | Format, Examples | ||
-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ||
**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 t/friend t/colleague` | ||
**Clear** | `clear` | ||
Action | Format, Examples | ||
--------|------------------ | ||
**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 t/friend t/colleague` | ||
**Clear** | `clear` | ||
**Delete** | `delete INDEX`<br> e.g., `delete 3` | ||
**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…`<br> e.g.,`edit 2 n/James Lee e/[email protected]` | ||
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake` | ||
**List** | `list` | ||
**Help** | `help` | ||
**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…`<br> e.g.,`edit 2 n/James Lee e/[email protected]` | ||
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake` | ||
**List** | `list` | ||
**Help** | `help` |
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,15 @@ | ||
title: "AB-3" | ||
theme: minima | ||
|
||
header_pages: | ||
- UserGuide.md | ||
- DeveloperGuide.md | ||
- AboutUs.md | ||
|
||
markdown: kramdown | ||
|
||
repository: "se-edu/addressbook-level3" | ||
github_icon: "images/github-icon.png" | ||
|
||
plugins: | ||
- jemoji |
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,23 @@ | ||
- name: "AB-1" | ||
url: https://se-edu.github.io/addressbook-level1 | ||
|
||
- name: "AB-2" | ||
url: https://se-edu.github.io/addressbook-level2 | ||
|
||
- name: "AB-3" | ||
url: https://se-edu.github.io/addressbook-level3 | ||
|
||
- name: "AB-4" | ||
url: https://se-edu.github.io/addressbook-level4 | ||
|
||
- name: "Duke" | ||
url: https://se-edu.github.io/duke | ||
|
||
- name: "Collate" | ||
url: https://se-edu.github.io/collate | ||
|
||
- name: "Book" | ||
url: https://se-edu.github.io/se-book | ||
|
||
- name: "Resources" | ||
url: https://se-edu.github.io/resources |
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,6 @@ | ||
{% comment %} | ||
Placeholder to allow defining custom head, in principle, you can add anything here, e.g. favicons: | ||
|
||
1. Head over to https://realfavicongenerator.net/ to add your own favicons. | ||
2. Customize default _includes/custom-head.html in your source directory and insert the given code snippet. | ||
{% endcomment %} |
Oops, something went wrong.