diff --git a/docs/README.md b/docs/README.md index 9f39f798e9e360006bac6460617daecc8a02fe47..06ca9632e2e11655bb3bfaa9cde053f783d8f6ca 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1 +1,37 @@ -# CEPCSW \ No newline at end of file +## Welcome to GitHub Pages + +You can use the [editor on GitHub](https://github.com/cepc/CEPCSW/edit/master/docs/README.md) to maintain and preview the content for your website in Markdown files. + +Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files. + +### Markdown + +Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for + +```markdown +Syntax highlighted code block + +# Header 1 +## Header 2 +### Header 3 + +- Bulleted +- List + +1. Numbered +2. List + +**Bold** and _Italic_ and `Code` text + +[Link](url) and  +``` + +For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/). + +### Jekyll Themes + +Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/cepc/CEPCSW/settings). The name of this theme is saved in the Jekyll `_config.yml` configuration file. + +### Support or Contact + +Having trouble with Pages? Check out our [documentation](https://docs.github.com/categories/github-pages-basics/) or [contact support](https://github.com/contact) and we鈥檒l help you sort it out. diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000000000000000000000000000000000000..c7418817439b2f071c93a4a6cee831e996123c0b --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-slate \ No newline at end of file