Skip to content

Commit

Permalink
Docs: Remove non-dev docs from README, point to user docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosperate committed Dec 22, 2019
1 parent f67c7c5 commit 3d41672
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 18 deletions.
21 changes: 5 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ Contributions are very welcomed!

## 🗂️ Readme Contents

This README only contains the developer documentation to edit this theme.
This README contains mostly the developer documentation to edit this theme.

To learn how to use this theme for your docs check out the
[Read The Docs Theme for Jekyll user documentation](https://carlosperate.github.io/jekyll-theme-rtd).
To learn how to use this theme for your own website or docs check out the
[user documentation](https://carlosperate.github.io/jekyll-theme-rtd).

- [🚀 Using this theme with GitHub Pages](#-using-this-theme-with-github-pages)
- [👩‍💻 Developer Documentation](#-developer-documentation)
Expand All @@ -48,19 +48,8 @@ To learn how to use this theme for your docs check out the

## 🚀 Using this theme with GitHub Pages

Add a `_config.yml` file to your GitHub pages repository (the `gh-pages` branch
or inside a `docs` folder in `master`, depending on the configured
[publishing source](https://help.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)
) with this line:

```yml
remote_theme: carlosperate/jekyll-theme-rtd
```
There are more configuration options explained in the
[\_config.yml documentation](https://carlosperate.github.io/jekyll-theme-rtd/configuration/configyml.html),
or you can have a look at the [\_config.yml from this repo](docs/_config.yml).
The fastest way to use this theme is with GitHub Pages, check out the
[Quick Start Guide from the user documentation](https://carlosperate.github.io/jekyll-theme-rtd/quickstart.html).

## 👩‍💻 Developer Documentation

Expand Down
4 changes: 2 additions & 2 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: default
title: Quick Start With GitHub Pages
title: 🚀 Quick Start With GitHub Pages
nav_order: 1
---

# Quick Start With GitHub Pages
# 🚀 Quick Start With GitHub Pages

There are several ways to configure the
[GitHub Pages publishing source](https://help.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site),
Expand Down

0 comments on commit 3d41672

Please sign in to comment.