- Publish your paper easily on online
- Write your paper in markdown which is a simple and easy-to-use format with professional templates
- Manage your paper with your source code in a repository
- Track your writings with Git version control
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.
- Usages
 |
 |
|---|---|
| homework | resume/cv |
- Templates
 |
 |
|---|---|
| two columns | one column |
- Recommend to use Chrome to see the paper
0. Click use this template button near the star button
1. Change baseurl in a _config.yml file as your repository
2. Write papers in markdown format
3. Push to your published repository branch
0. Install Jekyll (Ruby, RubyGems, GCC, Make, Bundler are also required)
- Referenced the installation guide of jekyll here
1. Clone your repository (after clicking the use this template button)
2. Use the following commands to run the server
$ bundle install
$ bundle exec jekyll serve