Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

template for gh pages landing page in /docs on master #31

Open
mihai-sysbio opened this issue Jul 28, 2021 · 0 comments
Open

template for gh pages landing page in /docs on master #31

mihai-sysbio opened this issue Jul 28, 2021 · 0 comments

Comments

@mihai-sysbio
Copy link
Member

The template could facilitate having a GH Pages website. I think it doesn't need to be bound to the docs folder on main anymore. Below is a draft:

- [x] `/docs/ `
The repository can contain a `/docs/` folder. A default is provided by the `standard-GEM` template. Its purpose is to instruct GitHub Pages to create a webpage from the main `/README.md` in the repository. This webpage serves as a friendly landing page that requires no maintenance, since it will always be in sync with the `/README.md`.  
The configuration of this webpage is specified by the `_config.yml` file, and can be modified to the desire of the repository owners. As specified in this file, the icon at `/docs/icon.png` will be used on this webpage.
One need to instruct GitHub to create a website by the following steps:
1. navigate to the repository settings
2. scroll down to the `GitHub Pages` section
3. select as `Source` the `master branch /docs folder`
4. the website is now available at `http(s)://{{organization or user}}.github.io/{{repository name}}`, for example `https://sysbiochalmers.github.io/yeast-GEM/`

_config.yml:

theme: jekyll-theme-minimal
logo: docs/icon.png
show_downloads: "true"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

No branches or pull requests

1 participant