Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/myty/muse
Website and Blog Engine
https://github.com/myty/muse
Last synced: 1 day ago
JSON representation
Website and Blog Engine
- Host: GitHub
- URL: https://github.com/myty/muse
- Owner: myty
- License: mit
- Created: 2014-09-10T00:52:38.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2023-04-15T22:21:20.000Z (over 1 year ago)
- Last Synced: 2024-04-14T13:46:34.199Z (7 months ago)
- Language: C#
- Homepage:
- Size: 2 MB
- Stars: 3
- Watchers: 4
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#Muse
[](https://ci.appveyor.com/project/MichaelTyson/shiny-myty-website)
A simple website and blog engine built on ASP.NET
##Overview
There are two seperate components to Muse:
1. An MVC server powered by [Nancy](https://github.com/NancyFx/Nancy).
2. A Github repository to hold all of your content.
These two components work in tandem. The content repository has a hook setup with a specially formed URL that when any changes are pushed to the repo it sends a POST message to the server. This Url has a secret key that only the server knows and responds to. If the key is wrong the message will fail. When the server does receive a valid message from the github repo, it will then pull the content from the repository and scan through it. For the scanning process, it first creates an in-memory structure backed by JSON files of the pages and posts. It then creates two static files. One, for the Atom RSS Feed, called atom.xml...and the other for the sitemap, called...sitemap.xml.
##Getting Started
###Server
```
git clone https://github.com/myty/muse.git
cd muse
```
Add a super-secret-sauce file to the root folder of your project and call it **env.config.json** and whatever you do; do _NOT_ commit this to Github. It holds your secret Github token you will need to pull from your repo of choice.
```json
{
"baseUrl": "http://mytydev.com",
"disqus_shortname": "mytyblog",
"ga_tracking_code": "UA-xxxxxx-xx",
"refreshToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"gitHubToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"sync": {
"owner": "myty",
"repo": "easily-amused-content",
"branch": "master",
"remoteFolders": ["_pages", "_posts", "_imgs", "_site"],
"locaStoragePath": "~/App_Data/Content"
}
}
```
- **baseUrl**: Set this to what your site will be
- **disqus_shortname**: To add Disqus support to your site, add your disqus_shortname that's linked to your Disqus account
- **ga_tracking_code**: _(optional)_ Google Analytics tracking code
- **refreshToken**: Can be any secret string you can come up with, but keep it a secret, otherwise anyone could be a jerk and totally make the server do a constant poll on your github account which will assuredly fill up your API request limit.
- **gitHubToken**: Is a personal access token that you can get from this page: https://github.com/settings/applications (again keep this secret)
- **sync**: This is object basically sets up which repo you want to pull from and from which branch and which folders you want to pull down to the server. The localStoragePath will set the location where the files will be stored on the server before the scanning process. More information on how to set this section up is in the section of the README documentation.
###Content
Fork **myty/muse-starter-content:** https://github.com/myty/muse-starter-content/fork
In your newly forked content repository, Go to Settings -> Webhooks & Services -> Add Webhook
- **Payload URL:** http://{baseUrl}/update?key={refreshToken}
_(replace {baseUrl} and {refreshToken} with what you previously setup in **env.config.json**)_.
- This is what will trigger the server to pull down fresh documents and whatever else you have set to be synced from your content repo
When setting up the content, there are some things you'll need to understand:
- **_imgs/\*.***: whatever files you put in here, will be available at /img/ on your site. You'd want to follow a convention of images in here, but you theoretically could put any file in here.
- **_pages/{slug}.md**: whatever markdown document you put in here will be available at /{slug}
- **_posts/{year}/{year}-{month}-{day}-{slug}.md**: The {year} folder is just for organizational purposes to keep your posts organized. The file name is what ultimately drives the url to the post. The pattern followed is: /{year}/{month}/{day}/{slug}
- **_site/config.json**: This file has everything to do with configuration:
- **siteTitle**: will display as the main title for the site
- **siteSubTitle**: on the home page, this will be under the main title
- **defaultImg**: In each page and post document there is an option of having a unique image for that particular page. defaultImg will be used if one is not configured.
- **socialLinks**: Right now the only websites handled are twitter or github. These are optional, but if you do have one of these, just replace with your own username.
```json
// _site/config.json
{
"id": "muse-starter-content",
"siteTitle": "Generic Site Title",
"siteSubTitle": "This is what your site is all about",
"defaultImg": "abstract-lights-motion.jpg",
"socialLinks":{
"twitter": "mytydev",
"github": "myty"
}
}
```
**page** and **post** documents both follow the same rules when it comes to building them. There is a top section and a bottom section. The top section is YAML configuration for the page and the bottom is your basic common markdown.
**Sample page**
```
---
title: "About Me"
subTitle: "Hello, my name is __________ _________."
headerBg: "/img/abstract-lights-motion.jpg"
date: 2015-01-01 -1100
siteMenu: "About"
siteMenuOrder: 0
layout: page
---
## About Me
This is a sample page with sample content
```
Things of note:
- **siteMenu** and **siteMenuOrder** are optional but if filled out will have your page show up in the top menu bar
- **layout** doesn't really do anything at the moment, but it will be used in the future for the purposes of having different layouts available.
**Sample Post**
```
---
title: "Hello, World"
subTitle: "This a sample post for the Muse blog engine"
headerBg: "/img/abstract-blurred-lines.jpg"
date: 2015-01-01 -1100
author: "You"
authorUrl: "/about"
comments: true
layout: post
---
The content for this site is specifically setup for a simple website and blog engine called, [Muse](http://github.com/myty/muse). Feel free to check out the code. Fork it. Make it better. Send your feedback.
More instructions will be provided to explain the different parts to the content specific parts to Muse.
```
Things of note:
- **author** and **authorUrl** are at the moment only used int he ATOM feed for the site, but a future verison of Muse may provide an author page of some sort
- **comments**: you can turn on and off comments in posts if you have disqus setup
- **layout** Same thing as the page document, this doesn't really do anything at the moment, but it will be used in the future for the purposes of having different layouts available.
###Additional Notes
You can test the Payload URL on your local machine using a tool like [Postman](https://chrome.google.com/webstore/detail/postman-rest-client-packa/fhbjgbiflinjbdggehcddcbncdddomop). Instead of using the baseUrl from env.config.json, you'd just put in the local address. _For example: http://localhost:5001/update?key=supersecretkey_
## Notable Third-Party Code In Use
- Nancy
- RestSharp
- Start Bootstrap
- Biggy
##Motivation For Muse
1. Partly because it was needed and partly to see if it could be done.
2. What better way to get involved in the developer community than releasing some code to the public.
##Sites Using Muse:
- http://mytydev.com
- _Your Site Goes Here_