Skip to content

Commit 1c461ae

Browse files
authored
Version 1.0.110 (#4)
* UPDATE: a filename * FIX: a typo * CREATE: an example of RESUME/CV * UPDATE: benefits for using templates && examples
1 parent 05aa118 commit 1c461ae

3 files changed

Lines changed: 9 additions & 4 deletions

File tree

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Paper Templates for GitHub Pages
22

3+
* Publish your paper easily on online
4+
* Write your paper in markdown which is a simple and easy-to-use format with professional templates
5+
* Manage your paper with your source code in a repository
6+
* Track your writings with Git version control
7+
38
Writing is important to proceed with a project as a way to communicate with stakeholders and record the progress. It is so clear that IT projects are especially underlined to be documented well. Many document management applications like Notion, Obsidian, and Evernote allow writers to easily share their notes with others. However, a platform where programmers take time and manage code is GitHub or GitLab which they inevitably utilize. This repository is a template repository for writing papers in markdown format and publishing them on GitHub Pages, which is a free static site hosting service provided by GitHub. The template expects that writers can focus on writing papers in a professional format without considering the design and layout of the paper due to the simple and easy-to-use markdown format.
49

510
## Examples
@@ -8,17 +13,17 @@ Writing is important to proceed with a project as a way to communicate with stak
813
|:--:|:--:|
914
|[two columns](https://dev-onejun.github.io/paper-templates-for-github-pages/examples/two-columns.html)|[one column](https://dev-onejun.github.io/paper-templates-for-github-pages/examples/one-column.html)|
1015

11-
| ![image](https://github.com/user-attachments/assets/dea57829-4d66-485a-bec0-6b09dcf400b4) |
12-
|:--:|
13-
|[usage case](https://dev-onejun.github.io/paper-templates-for-github-pages/examples/usage.pdf)|
16+
| ![image](https://github.com/user-attachments/assets/dea57829-4d66-485a-bec0-6b09dcf400b4) | ![image]() |
17+
|:--:|:--:|
18+
|[homework](https://dev-onejun.github.io/paper-templates-for-github-pages/examples/homework.pdf)|[resume/cv](https://dev-onejun.github.io/paper-templates-for-github-pages/examples/resume-cv.pdf)|
1419

1520
## Usages
1621

1722
* Recommend to use Chrome to see the paper
1823

1924
**0.** Click `use this template` button near the star button
2025

21-
**1.** Change `baseurl` in a `_configy.yml` file as your repository
26+
**1.** Change `baseurl` in a `_config.yml` file as your repository
2227

2328
**2.** Write papers in markdown format
2429

examples/resume.pdf

88.2 KB
Binary file not shown.

0 commit comments

Comments
 (0)