|
1 | | -This is the source code for the main website of IQ-TREE. |
2 | | -If you want to contribute to the documentation of IQ-TREE, there are several markdown file in the `doc` folder. Simply clone this repo, and make a pull request if you want to contribute. Thank you! |
| 1 | +Introduction |
| 2 | +============ |
| 3 | + |
| 4 | +This repository stores the "source code" for the main IQ-TREE website at |
| 5 | +<https://iqtree.github.io>. Changes to this repo will automatically show up |
| 6 | +in the main website via GitHub pages support. |
| 7 | + |
| 8 | +We welcome you to contribute to the website! For example, you can improve the |
| 9 | +documentation at <https://iqtree.github.io/doc/> by updating _markdown_ files |
| 10 | +within the [doc](doc/) folder of the repo. |
| 11 | +[Markdown](https://en.wikipedia.org/wiki/Markdown) is a human-readable text |
| 12 | +file format, which is very simple and convenient to edit. If you are teaching |
| 13 | +IQ-TREE at a workshop, you can update the markdown files in the |
| 14 | +[workshop](workshop/) folder, which will then show up at |
| 15 | +<https://iqtree.github.io/workshop/>. Below are the guidelines how to |
| 16 | +contribute. |
| 17 | + |
| 18 | +First, you should clone the repo to your local machine using git: |
| 19 | + |
| 20 | +``` |
| 21 | +git clone https://github.com/iqtree/iqtree.github.io.git |
| 22 | +``` |
| 23 | + |
| 24 | +This will download a local copy of the repo in the sub-folder `iqtree.github.io` |
| 25 | +of your current folder. This step needs to be done only ONCE! You can then |
| 26 | +follow the sections below for the two common tasks: [updating a |
| 27 | +documentation](#updating-iq-tree-documentation) or [updating a workshop](#updating-a-workshop). |
| 28 | + |
| 29 | + |
| 30 | +Updating IQ-TREE documentation |
| 31 | +------------------------------ |
| 32 | + |
| 33 | +The names of the files in [doc](doc/) folder are self-explanatory. For example, |
| 34 | +[doc/Tutorial.md](doc/Tutorial.md) corresponds to |
| 35 | +<https://iqtree.github.io/doc/Tutorial>. Each markdown file contains a header |
| 36 | +and the main text. Once you update the main text, make sure that you also update |
| 37 | +the header, especially the two fields: `author` to add your name (if it does |
| 38 | +appear in the author list yet) and `date` to the current date. For example, |
| 39 | + |
| 40 | +``` |
| 41 | +--- |
| 42 | +layout: userdoc |
| 43 | +title: "Beginner's Tutorial" |
| 44 | +author: Minh Bui, Your Name |
| 45 | +date: YYYY-MM-DD |
| 46 | +... |
| 47 | +--- |
| 48 | +``` |
| 49 | + |
| 50 | +If you add a new section in the doc, make sure that you also add |
| 51 | +the `sections` part of the header, for example: |
| 52 | + |
| 53 | +``` |
| 54 | +--- |
| 55 | +.... |
| 56 | +sections: |
| 57 | +- name: Your section title |
| 58 | + url: your-section-title |
| 59 | +--- |
| 60 | +``` |
| 61 | + |
| 62 | +where the `url` field should be all in lower cases and empty spaces are replaced |
| 63 | +by a dash (`-`). |
| 64 | + |
| 65 | +Once you are satisfied with the changes you can then commit it: |
| 66 | + |
| 67 | +``` |
| 68 | +git commit -am "Message about this commit" |
| 69 | +``` |
| 70 | + |
| 71 | +Please make the message concise but informative about what you did. Then you |
| 72 | +can make a pull request to ask us to update the main repo. An IQ-TREE team |
| 73 | +member will review your pull request before deciding to merge it into the main |
| 74 | +site, optional modifications to your pull request. Occasionally, the |
| 75 | +IQ-TREE member may ask you to revise your pull request, before making decision. |
| 76 | + |
| 77 | +Updating a workshop |
| 78 | +------------------- |
| 79 | + |
| 80 | +The workshop materials are in the [workshop](workshop/) subfolder. There are already |
| 81 | +some past workshops that you can have a look. |
| 82 | + |
| 83 | + |
0 commit comments