generated from mikepierce/conference-website-template
-
-
Notifications
You must be signed in to change notification settings - Fork 0
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 #17 from common-workflow-language/update-readme
Remove template, added simple Readme with links
- Loading branch information
Showing
2 changed files
with
24 additions
and
71 deletions.
There are no files selected for viewing
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,81 +1,34 @@ | ||
| [](https://mikepierce.github.io/conference-website-template/) | ||
| [![Screenshot of the Website][screenshot_of_conference_website]][conference_site] | ||
|
|
||
| --- | ||
| ## Welcome to the CWLCon 2024 Site | ||
|
|
||
| [](https://www.gnu.org/licenses/gpl-3.0) | ||
| [](https://www.buymeacoffee.com/mpierce) | ||
| The rendered website can be viewed [here][conference_site]. | ||
|
|
||
| An HTML/CSS website template perfect for a small academic or technology conference or seminar. | ||
| The template is quick to deploy and straightforward to customize. | ||
| You can [explore it live here](https://mikepierce.github.io/conference-website-template/), | ||
| and see some folks' use of the template | ||
| [here](https://math.ucr.edu/~mathconn/) | ||
| and [here](https://data-science-conference.github.io) | ||
| and [here](https://aquaticdatasciopensci.github.io) | ||
| and [here](https://comp-expe.github.io) | ||
| and [here](https://enba-phd-call.github.io) | ||
| and [here](https://strl2022.github.io). | ||
| I'd be happy to see the site you create from my template ☺ | ||
| This repository is used to: | ||
|
|
||
| ## Installation | ||
| 1. Collaborate our [to-do list][issues_page] | ||
| 2. Make changes to the conference site | ||
|
|
||
| If you have access to a server for web hosting, | ||
| perhaps through your company/university or department, | ||
| then using this template is as easy as cloning this repository | ||
| directly into your public HTML directory. | ||
| If not you can pretty easily host a website using this template with [GitHub Pages](https://pages.github.com/). | ||
| See that link for more details, but the basic procedure is this: | ||
| ## Conference Organisers | ||
|
|
||
| 1. Create a GitHub repository named `username.github.io`, | ||
| where *username* is your username on GitHub. | ||
| * [Michael Crusoe](https://github.com/mr-c) | ||
| * [Iacopo Colonnelli](https://github.com/GlassOfWhiskey) | ||
| * [Manabu ISHII](https://github.com/manabuishii) | ||
| * [Bruno P. Kinoshita](https://github.com/kinow) | ||
| * [Radhika Khetani](https://github.com/rkhetani) | ||
| * [Sehrish Kanwal](https://github.com/skanwal) | ||
| * [Alexis Lucattini](https://github.com/alexiswl) | ||
| * [Tazro Inutano Ohta](https://github.com/inutano) | ||
| * [Tomoya Tanjo](https://github.com/tom-tan) | ||
|
|
||
| 2. Click the *Use this template* button above, | ||
| being sure to give your copy of this repository a more apt name, | ||
| like *awesome-conference*. | ||
| ## Contributing | ||
|
|
||
| 3. In your copy go to *Settings* and scroll down to *GitHub Pages*. | ||
| Under *Source* choose the master branch of your forked copy. | ||
| Then your copy of the website will be hosted at `username.github.io/awesome-conference`. | ||
| If you would like to be a conference organiser please reach out to one of us through the [Gitter App][gitter_app_link]. | ||
|
|
||
| ## Editing the Template | ||
|
|
||
| If you have not edited HTML/CSS to design a webpage before, | ||
| I encourage you to read | ||
| [How to Build a Personal Webpage from Scratch](https://rutar.org/writing/how-to-build-a-personal-webpage-from-scratch/) | ||
| by Alex Rutar, particularly the | ||
| [Crash course in HTML and CSS](https://rutar.org/writing/how-to-build-a-personal-webpage-from-scratch/#crash-course-in-html-and-css) | ||
| section. | ||
|
|
||
| ## Beautiful Math with MathJax (optional) | ||
|
|
||
| It may be helpful to include mathematical notation on this website, especially in the abstracts of talks. | ||
| This can be done using [MathJax](https://github.com/mathjax/MathJax). | ||
| For an example see the [*programs* page](https://mikepierce.github.io/conference-website-template/program/) of the template site. | ||
| To include math in a page of this website, include the lines | ||
|
|
||
| ````HTML | ||
| <script type="text/javascript" async | ||
| src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=default"> | ||
| </script> | ||
| ```` | ||
|
|
||
| in the `<head>` of the HTML file. Then math can by typeset by using LaTeX's math notation enclosed in `\(...\)` delimiters. | ||
|
|
||
| ## Sitemap (optional) | ||
|
|
||
| The file `sitemap.xml` helps search engines understand the structure of your site. | ||
| In this file, each instance of "WEBSITE" should be replaced | ||
| with the actual address where this website is being hosted. | ||
| See the [sitemaps protocol page](https://www.sitemaps.org/protocol.html) for more details. | ||
|
|
||
| ## Alternatives | ||
|
|
||
| The simplicity of the HTML/CSS source for this template is its strongest feature. | ||
| For something more slick or modern or sophisticated or complicated: | ||
|
|
||
| - [Hoverboard](https://github.com/gdg-x/hoverboard) is beautiful but requires some tech know-how to setup. | ||
|
|
||
| - You can build something from scratch based on a | ||
| [GitHub Pages site with Jekyll](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll) | ||
| or a template from [Pixelarity](https://pixelarity.com). | ||
| If you see an error or issue in the site, please consider raising a [GitHub Issue][issues_page] and / or making a [PR][pr_page] to this repository | ||
|
|
||
| [conference_site]: https://commonwl.org/conferences/2024 | ||
| [issues_page]: https://github.com/common-workflow-language/cwlcon-2024/issues | ||
| [pr_page]: https://github.com/common-workflow-language/cwlcon2024/pulls | ||
| [screenshot_of_conference_website]: images/screenshot_of_conference_website.png | ||
| [gitter_app_link]: https://matrix.to/#/#common-workflow-language_common-workflow-language:gitter.im |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.