Update README.md
This commit is contained in:
KodeStar
GitHub
parent
250ac1142d
commit
24e1559051
1 changed files with 35 additions and 91 deletions
126
docs/README.md
126
docs/README.md
|
|
@ -1,108 +1,52 @@
|
|||
# Heimdall
|
||||
|
||||
|
||||
|
||||
*Tactile is a Jekyll theme for GitHub Pages. You can [preview the theme to see what it looks like](http://pages-themes.github.io/tactile), or even [use it today](#usage).*
|
||||
## About
|
||||
|
||||
|
||||
An Application dashboard and launcher
|
||||
|
||||
## Usage
|
||||
## Video
|
||||
If you want to see a quick video of it in use, go to https://drive.google.com/file/d/1cijXgmjem_q2OfKMp36qVuXRiyOzvhWC/view
|
||||
|
||||
To use the Tactile theme:
|
||||
## Web Server Configuration
|
||||
|
||||
1. Add the following to your site's `_config.yml`:
|
||||
### Apache
|
||||
A .htaccess file ships with the app, however, if it does not work with your Apache installation, try this alternative:
|
||||
|
||||
```yml
|
||||
theme: jekyll-theme-tactile
|
||||
```
|
||||
```
|
||||
Options +FollowSymLinks
|
||||
RewriteEngine On
|
||||
|
||||
2. Optionally, if you'd like to preview your site on your computer, add the following to your site's `Gemfile`:
|
||||
|
||||
```ruby
|
||||
gem "github-pages", group: :jekyll_plugins
|
||||
```
|
||||
|
||||
## Customizing
|
||||
|
||||
### Configuration variables
|
||||
|
||||
Tactile will respect the following variables, if set in your site's `_config.yml`:
|
||||
|
||||
```yml
|
||||
title: [The title of your site]
|
||||
description: [A short description of your site's purpose]
|
||||
RewriteCond %{REQUEST_FILENAME} !-d
|
||||
RewriteCond %{REQUEST_FILENAME} !-f
|
||||
RewriteRule ^ index.php [L]
|
||||
```
|
||||
|
||||
Additionally, you may choose to set the following optional variables:
|
||||
### Nginx
|
||||
If you are using Nginx, the following directive in your site configuration will direct all requests to the index.php front controller:
|
||||
|
||||
```yml
|
||||
show_downloads: ["true" or "false" to indicate whether to provide a download URL]
|
||||
google_analytics: [Your Google Analytics tracking ID]
|
||||
```
|
||||
location / {
|
||||
try_files $uri $uri/ /index.php?$query_string;
|
||||
}
|
||||
```
|
||||
Someone was using the same nginx setup to both run this and reverse proxy Plex, Plex is served from /web so their location was interferring with the /webfonts.
|
||||
|
||||
### Stylesheet
|
||||
Therefore, if your fonts aren't showing because you have a location for /web add the following
|
||||
```
|
||||
location /webfonts {
|
||||
try_files $uri $uri/;
|
||||
}
|
||||
```
|
||||
If there are any other locations which might interefere with any of the folders in the /public folder, you might have to do the same for those as well, but it's a super fringe case.
|
||||
|
||||
If you'd like to add your own custom styles:
|
||||
## Credits
|
||||
- PHP Framework - [Laravel](https://laravel.com/)
|
||||
- Icons - [FonteAwesome 5](https://fontawesome.com/)
|
||||
- Javascript - [jQuery](https://jquery.com/)
|
||||
- Colour picker - [Huebee](http://huebee.buzz/)
|
||||
|
||||
1. Create a file called `/assets/css/style.scss` in your site
|
||||
2. Add the following content to the top of the file, exactly as shown:
|
||||
```scss
|
||||
---
|
||||
---
|
||||
## License
|
||||
|
||||
@import "{{ site.theme }}";
|
||||
```
|
||||
3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line
|
||||
|
||||
*Note: If you'd like to change the theme's Sass variables, you must set new values before the `@import` line in your stylesheet.*
|
||||
|
||||
### Layouts
|
||||
|
||||
If you'd like to change the theme's HTML layout:
|
||||
|
||||
1. [Copy the original template](https://github.com/pages-themes/tactile/blob/master/_layouts/default.html) from the theme's repository<br />(*Pro-tip: click "raw" to make copying easier*)
|
||||
2. Create a file called `/_layouts/default.html` in your site
|
||||
3. Paste the default layout content copied in the first step
|
||||
4. Customize the layout as you'd like
|
||||
|
||||
### Overriding GitHub-generated URLs
|
||||
|
||||
Templates often rely on URLs supplied by GitHub such as links to your repository or links to download your project. If you'd like to override one or more default URLs:
|
||||
|
||||
1. Look at [the template source](https://github.com/pages-themes/tactile/blob/master/_layouts/default.html) to determine the name of the variable. It will be in the form of `{{ site.github.zip_url }}`.
|
||||
2. Specify the URL that you'd like the template to use in your site's `_config.yml`. For example, if the variable was `site.github.url`, you'd add the following:
|
||||
```yml
|
||||
github:
|
||||
zip_url: http://example.com/download.zip
|
||||
another_url: another value
|
||||
```
|
||||
3. When your site is built, Jekyll will use the URL you specified, rather than the default one provided by GitHub.
|
||||
|
||||
*Note: You must remove the `site.` prefix, and each variable name (after the `github.`) should be indent with two space below `github:`.*
|
||||
|
||||
For more information, see [the Jekyll variables documentation](https://jekyllrb.com/docs/variables/).
|
||||
|
||||
## Roadmap
|
||||
|
||||
See the [open issues](https://github.com/pages-themes/tactile/issues) for a list of proposed features (and known issues).
|
||||
|
||||
## Project philosophy
|
||||
|
||||
The Tactile theme is intended to make it quick and easy for GitHub Pages users to create their first (or 100th) website. The theme should meet the vast majority of users' needs out of the box, erring on the side of simplicity rather than flexibility, and provide users the opportunity to opt-in to additional complexity if they have specific needs or wish to further customize their experience (such as adding custom CSS or modifying the default layout). It should also look great, but that goes without saying.
|
||||
|
||||
## Contributing
|
||||
|
||||
Interested in contributing to Tactile? We'd love your help. Tactile is an open source project, built one contribution at a time by users like you. See [the CONTRIBUTING file](docs/CONTRIBUTING.md) for instructions on how to contribute.
|
||||
|
||||
### Previewing the theme locally
|
||||
|
||||
If you'd like to preview the theme locally (for example, in the process of proposing a change):
|
||||
|
||||
1. Clone down the theme's repository (`git clone https://github.com/pages-themes/tactile`)
|
||||
2. `cd` into the theme's directory
|
||||
3. Run `script/bootstrap` to install the necessary dependencies
|
||||
4. Run `bundle exec jekyll serve` to start the preview server
|
||||
5. Visit [`localhost:4000`](http://localhost:4000) in your browser to preview the theme
|
||||
|
||||
### Running tests
|
||||
|
||||
The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run `script/cibuild`. You'll need to run `script/bootstrap` one before the test script will work.
|
||||
This app is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
|
||||
|
|
|
|||
Loading…
Reference in a new issue