https://github.com/codesequence/sanmyaku
A mountain theme for Vanilla Forums built on Foundation 5.
https://github.com/codesequence/sanmyaku
Last synced: 3 months ago
JSON representation
A mountain theme for Vanilla Forums built on Foundation 5.
- Host: GitHub
- URL: https://github.com/codesequence/sanmyaku
- Owner: CodeSequence
- License: mit
- Created: 2014-02-24T23:14:00.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2023-09-06T13:16:51.000Z (almost 2 years ago)
- Last Synced: 2024-04-23T14:05:38.378Z (about 1 year ago)
- Language: SCSS
- Homepage: https://vanillaforums.org/addon/sanmyaku-theme
- Size: 28.8 MB
- Stars: 8
- Watchers: 5
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Sanmyaku: A theme for Vanilla Forums
[](https://github.com/CodeSequence/sanmyaku/issues/59)
[](https://github.com/codesequence/sanmyaku/releases)
## Getting started
To get started using Sanmyaku for Vanilla, either:
* [__Download the latest release__](https://github.com/codesequence/sanmyaku/releases)
* Clone the repository directly into your Vanilla `themes` directory and build the project:
```sh
$ git clone https://github.com/CodeSequence/sanmyaku.git
$ cd sanmyaku
$ npm install
$ gulp build
```
## prerequisites
You will need to following tools globally installed to build this theme:
* node ~v5.5.0
* npm ~3.3.12
* bower ~1.4.1
## Compiling assets
Run `npm install` to get started.
#### Build - `gulp build`
Runs the default Gulp task which will compile all theme assets.
* JavaScripts will be concatenated and output to (js/custom.js).
* Sass stylesheets will be compiled to (design/custom.css).
* Sass theme-option stylesheets will be prefixed with `custom_` and compiled to (design/custom_themeoptionname.css).
* Images are optimized and placed in (app/images).
* Theme screenshots are optimized and place in (design/imagename.png).
* Icons are compiled to (app/icons).
#### Watch - `gulp`
Starts the build process and then uses browserync to watch and update the browser on changes.
To use the watch process you will need to update your (`gulp/config.js`) `projectUrl` to be the url used for development.
#### Theme Options
The theme comes pre-configured with a light and dark theme. Light is the default and dark can be set under theme options in the admin panel.
#### Mobile Theme
Sanmyaku is built to be responsive. The mobile theme will automatically be set to Sanmyaku during install.
###### To manually set this as your mobile theme:
Edit the vanilla forums `conf/config.php` file
Update or add `$Configuration['Garden']['MobileTheme'] = 'sanmyaku';`.
#### Easily Customizable
The theme is easy to customize. Simply update the variables located in the `app/scss/theme_options/dark/_settings.scss` file to easily change fonts, colors & images. Another option is to copy the dark theme directory and create a new theme folder and sass file with the name of your theme that imports the new theme folder. You will then need to add the theme options name to `about.php` file after `'Dark' => '%s_dark'`.
If you have built an awesome color scheme and want to share it with the community, submit a pull request!
#### Supported Plugins
Check out the list of [supported plugins](./plugins.md).
## [Issue tracking](https://github.com/codesequence/sanmyaku/issues)
If you come across any bugs or if you have a feature request, please file an issue using the GitHub Issue tracker. The Sanmyaku theme won't be supported through http://vanillaforums.org so please stick to using GitHub for inquiries about bugs and feature requests. Thanks!
[__File a new issue or feature request__](https://github.com/codesequence/sanmyaku/issues/new)
---
Copyright 2016 © [CodeSequence](https://github.com/codesequence). Licensed under the terms of the [MIT License](LICENSE.md)
Based on the original Foundation theme developed by [Kasper Kronborg Isager](http://kasperisager.github.io)