{{NAME}} :: viewdocs.io

├── .editorconfig ├── .gitignore ├── .godir ├── Procfile ├── README.md ├── docs ├── custom-layouts.md ├── development.md ├── example.md ├── index.md ├── screen.css └── template.html ├── go.mod ├── go.sum ├── viewdocs.go └── viewdocs_test.go /.editorconfig: -------------------------------------------------------------------------------- 1 | # editorconfig.org 2 | root = true 3 | 4 | [*] 5 | indent_style = space 6 | indent_size = 4 7 | end_of_line = lf 8 | charset = utf-8 9 | trim_trailing_whitespace = true 10 | insert_final_newline = true 11 | 12 | [*.go] 13 | indent_size = 4 14 | indent_style = tab 15 | 16 | [Makefile] 17 | indent_size = 4 18 | indent_style = tab 19 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Binaries for programs and plugins 2 | *.exe 3 | *.exe~ 4 | *.dll 5 | *.so 6 | *.dylib 7 | 8 | # Test binary, build with `go test -c` 9 | *.test 10 | 11 | # Output of the go coverage tool, specifically when used with LiteIDE 12 | *.out 13 | 14 | # Build output 15 | build/* 16 | 17 | # Release output 18 | release/* 19 | 20 | # .env files 21 | .env* 22 | 23 | viewdocs 24 | .env 25 | -------------------------------------------------------------------------------- /.godir: -------------------------------------------------------------------------------- 1 | viewdocs 2 | -------------------------------------------------------------------------------- /Procfile: -------------------------------------------------------------------------------- 1 | web: viewdocs -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Viewdocs 2 | 3 | Viewdocs is [Read the Docs](https://readthedocs.org/) meets [Gist.io](http://gist.io/) for simple Markdown project documentation. 4 | 5 | See it in action at http://viewdocs.io/ 6 | -------------------------------------------------------------------------------- /docs/custom-layouts.md: -------------------------------------------------------------------------------- 1 | # Custom Layouts 2 | 3 | Viewdocs.io requires a layout template in order to render your markdown pages. The layout file, template.html, must be located at the root of your docs directory. A default layout is included - and was used to render the page you are currently reading. Developing a custom layout is simple, as long as certain constraints are accomodated. 4 | 5 | ## Template Tags 6 | 7 | Template tags are case sensitive upper case identifiers. The following tags are supported: 8 | 9 | 1. {{USER}} - the Github user name of the repository 10 | 2. {{NAME}} - the name of the repository 11 | 3. {{CONTENT}} - the contents of the markdown document when rendered 12 | 4. {{PAGE_CLASS}} - a css class representation of the current url 13 | 5. {{REF}} - the current repository reference, usually master 14 | 5. {{DOC}} - the name of the markdown file being viewed. 15 | 16 | Here's a sample Bootstrap & Angularjs based template: 17 | 18 | ```html 19 | 20 | 21 | 22 | 23 | {{NAME}} :: viewdocs.io 24 | 25 | 26 | 27 |

28 | 29 |

30 |

31 |

32 |

33 |

34 | {{CONTENT}} 35 |

36 |

37 |

38 |

39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | ``` 48 | 49 | ## Static Assets 50 | 51 | The viewdocs.io server only serves markdown files. Static files such as javascript, image, css, etc. must be served from an alternate location. Google and cloudflare serve many popular libraries, for example: 52 | 53 | 54 | 55 | 56 | Ideally, you'll want to serve assets from your Github repository. Github has instituted anti-hotlinking provision on their `raw.github.com` domain. However, if you enable Github Pages for your repo Github will serve your files from their github.io domain. 57 | 58 | A principal motivation for the development of viewdocs.io was to avoid having to maintain a separate gh-pages branch in order to serve a library documentation site. It may seem contradictory to maintain a gh-pages branch to serve assets for a viewdocs.io site. The following setup makes serving static assets from Github Pages painless. 59 | 60 | ### Painless Github Pages Setup 61 | 62 | OK - it's a simple one-time setup, with all work local to your repository. Don't follow 63 | any other `gh-pages` tutorials, as we're not publishing a site, just serving our static 64 | assets from our `/docs` directory. (Repeat steps 2 & 3 on each workspace - i.e. If you work on your project at home & at work, repeat steps 2 & 3 each location.) 65 | 66 | 1. Start with an current clean repository, on the master branch. It's easiest to work from 67 | a new clone. Create a `gh-pages` branch that is identical to your `master` branch: 68 | 69 | git clone git@github.com:your-user/your-repo.git 70 | cd your-repo 71 | git branch gh-pages master 72 | 73 | 2. Add a file, `.git/hooks/post-commit` with the following contents 74 | 75 | #!/bin/sh 76 | git branch -f gh-pages master 77 | 78 | make it executable 79 | 80 | chmod u+x .git/hooks/post-commit 81 | 82 | This `post-commit` hook automatically forces the gh-pages branch to mirror the master branch. 83 | 84 | 3. Edit your `.git/config` file so that the `[remote "origin"]` section looks like this: 85 | 86 | [remote "origin"] 87 | url = git@github.com:your-user/your-repo.git 88 | fetch = +refs/heads/*:refs/remotes/origin/* 89 | push = refs/heads/master:refs/heads/master 90 | push = refs/heads/gh-pages:refs/heads/gh-pages 91 | 92 | now when you `git push origin` you automatically push both `master` and `gh-pages` branches 93 | 94 | 4. Tell Github that you are not using Jekyll 95 | 96 | touch .nojekyll 97 | 98 | 5. Check in your changes and push to origin, adding the gh-pages branch to Github: 99 | 100 | git add -A . 101 | git commit -m "now serving assets from github.io" 102 | git push origin 103 | 104 | Wait ten minutes for Github to notice your new gh-pages branch and start serving your files. Now, in your templates you can reference: 105 | 106 | http://{{USER}}.github.io/{{NAME}}/docs/assets/css/demo.css 107 | 108 | assuming you created a file `demo.css` and put it at `assets/css` relative to your docs folder. Note that you may experience up to a 10 minute delay before change pushed to Github are reflected at the github.io domain. 109 | 110 | 111 | 112 | ## JSON, HTLM Partials and Ajax 113 | 114 | Since static assets are being served via github.io, and your primary domain is viewdocs.io, ajax requests will be considered 'cross-domain.' Unfortunately, Github Pages doesn't support CORS. Here are two methods that can be used to work around that limitation. 115 | 116 | ### HTML Partials 117 | 118 | HTML partials for Angularjs templates can be embedded in your template.html, for example, the following embedded template: 119 | 120 | 150 | 151 | can be referenced in javascript as if it were remote: 152 | 153 | directive('navbar', ['$location', '$http', function ($location, $http) { 154 | return { 155 | restrict: 'E', 156 | transclude: true, 157 | scope: { heading: '@'}, 158 | controller: 'NavbarCtrl', 159 | templateUrl: 'navbar.html', 160 | replace: true, 161 | ... 162 | 163 | ### JSON 164 | 165 | JSON can be embedded in a markdown file and then parsed out of the rendered page. Given the following markdown content in a file nav.md: 166 | 167 |

168 | [ 169 | {"title": "Getting Started", "link": "getting-started"}, 170 | {"title": "API", "link": "api"}, 171 | {"title": "Validations", "link": "validations"}, 172 | {"title": "Query Language", "link": "gql"}, 173 | {"title": "Examples", "link": "examples"}, 174 | {"title": "Annotated Code", "link": "annotated"} 175 | ] 176 |

177 | 178 | 179 | The following example javascript function will request and extract it. 180 | 181 | var itemsXpath = '//*[@id="global"]/div/div'; 182 | var itemsUrl = 'http://'+ $scope.user + '.viewdocs.io/' + $scope.name + '/nav'; 183 | $http.get(itemsUrl).success(function(data) { 184 | var parser = new DOMParser(); 185 | var doc = parser.parseFromString(data, "text/html"); 186 | 187 | $scope.items = angular.fromJson(getElementByXpath(doc,itemsXpath).innerText); 188 | navbarCtrl.selectByUrl($location.absUrl()); 189 | }); 190 | 191 | 192 | Note: 193 | - The Github Markdown API strips id and class attributes from html tags. 194 | - Not all browsers' DOMParser implementations support 'text/html' format. A shim can be found here: https://gist.github.com/1129031 195 | 196 | 197 | -------------------------------------------------------------------------------- /docs/development.md: -------------------------------------------------------------------------------- 1 | # Development 2 | 3 | Viewdocs is written in [Go](http://golang.org/) and interacts with the [GitHub 4 | Markdown API](http://developer.github.com/v3/markdown/). 5 | 6 | If you want to hack on it, first you'll need to [get your GitHub access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use) 7 | and prepare your environment with something like the script below: 8 | 9 | ```sh 10 | export ACCESS_TOKEN='' 11 | echo '127.0.0.1 .viewdocs.dev' | sudo tee -a /etc/hosts 12 | ``` 13 | 14 | After that, just sing that same old song: 15 | 16 | ```sh 17 | mkdir -p $GOPATH/src/github.com/progrium 18 | cd $GOPATH/src/github.com/progrium 19 | git clone https://github.com/progrium/viewdocs.git 20 | cd viewdocs 21 | glide install 22 | go run viewdocs.go 23 | ``` 24 | 25 | Then visit `http://.viewdocs.dev:8888/` on 26 | your browser and enjoy! 27 | -------------------------------------------------------------------------------- /docs/example.md: -------------------------------------------------------------------------------- 1 | # Example page 2 | 3 | Hello there! This is an example documentation page for [Viewdocs](http://viewdocs.io), a super-lightweight project documentation platform inspired by [Gist.io](http://gist.io). 4 | 5 | Now look up. _Further_. Above the post title. See that grey text? 6 | 7 | Now back to me. That grey text is a link! Open that sucker in a new tab to see the project for this documentation. 8 | 9 | ## This is a major heading 10 | 11 | If you peek at it with a web inspector, you'll see that it is a second-level heading. You can use first level headings, but they'll look just like the second level ones, and the gods of the [HTML5 outlining algorithm](http://html5doctor.com/outlines/) will frown upon you. 12 | 13 | There's nothing stopping you from using `H3`, `H4`, or `H5`. They are all appropriately styled with a nod to [Bringhurst](http://www.amazon.com/Elements-Typographic-Style-Robert-Bringhurst/dp/0881791326), and you can check out a preview of how they look below. 14 | 15 | ### This is a third-level heading 16 | 17 | Classy, eh? Those are actually real small-caps, courtesy of the lovely argentine typeface, [Alegreya](http://www.huertatipografica.com.ar/tipografias/alegreya/ejemplos.html) (available from Google webfonts in [regular](http://www.google.com/webfonts/specimen/Alegreya) and [small-caps](http://www.google.com/webfonts/specimen/Alegreya+SC) variants). Here, have some [slipsum](http://slipsum.com) in a `

`: 18 | 19 | > Now that we know who you are, I know who I am. I'm not a mistake! It all makes sense! In a comic, you know how you can tell who the arch-villain's going to be? He's the exact opposite of the hero. And most times they're friends, like you and me! I should've known way back when... You know why, David? Because of the kids. They called me Mr Glass. 20 | 21 | #### This is a fourth-level heading 22 | 23 | Down here we are quite in the weeds already. I guess this is a good a time as any to say that lists are appropriately styled: 24 | 25 | ##### Milkshake ingredients to get at the supermarket 26 | 27 | * Bananas 28 | * Cocoa 29 | * Milk 30 | 31 | _Add bananas, chocolate milk powder, and milk to blender. Blend at high-speed until suitably frothy. Drink and then instagram a pic of your milkshake moustache for extra hipster cool points or something._ 32 | 33 | ##### Steps to recovery from milkshake addiction 34 | 35 | 1. Discard your blender to remove temptation. 36 | 2. Don't make milkshakes. 37 | 3. Repeat step 2 until unreasonable desire for milkshakes has abated. 38 | 39 | By the way, the "Milkshakes ingredients" subtitle was a fifth-level heading. It's rare that you need those, and I don't think you'll ever need a H6, so I didn't style those at all. 40 | 41 | Since you've come this far, you are probably wondering why I don't support something you want me to support. You can help make Viewdocs better by [contributing to the project](https://github.com/progrium/viewdocs) or [filing a bug/feature request](https://github.com/progrium/viewdocs/issues). 42 | 43 | ## Also: Syntax highlighting 44 | 45 | By referencing a [pygments](http://pygments.org/) stylesheet on your docs layout, you'll get some nice looking code blocks, just like you do on your READMEs hosted on GitHub. 46 | 47 | Here's some Ruby code: 48 | 49 | ```ruby 50 | class User 51 | attr_accessor :name, :email, :password 52 | def valid_password?(password) 53 | password == 'WAT?!' 54 | end 55 | end 56 | ``` 57 | 58 | And some Golang code: 59 | 60 | ```go 61 | package main 62 | import "fmt" 63 | 64 | func main() { 65 | fmt.Println("Hello world!") 66 | } 67 | ``` 68 | 69 | ## Also: images 70 | 71 | You can embed images in posts too, and they'll respect the width of your browser: 72 | 73 | 74 | 75 | *A photo a woman bathing in the Ganges river* -------------------------------------------------------------------------------- /docs/index.md: -------------------------------------------------------------------------------- 1 | # Welcome to Viewdocs 2 | 3 | Viewdocs is [Read the Docs](https://readthedocs.org/) meets [Gist.io](http://gist.io/) for simple project documentation. It renders Markdown from your repository's `docs` directory as simple static pages. 4 | 5 | ### Getting Started 6 | 7 | Just make a `docs` directory in your Github project repository and put an `index.md` file in there to get started. Then browse to: 8 | 9 | http://.viewdocs.io/ 10 | 11 | Any other Markdown files in your `docs` directory are available as a subpath, including files in directories. You can update pages by just pushing to your repository or editing directly on Github. It can take up to 1-2 minutes before changes will appear. 12 | 13 | This page is an example of what documentation will look like by default. Here is [another example page](/viewdocs/example). The source for these pages are in the [docs directory](https://github.com/progrium/viewdocs/tree/master/docs) of the Viewdocs project. 14 | 15 | ### Preview changes before pushing documentation back the repository 16 | 17 | If you want to find out how things look like locally before pushing your code back to the remote repository, you might want to try out [`previewdocs`](http://fgrehm.viewdocs.io/previewdocs). 18 | 19 | ### Advanced Usage 20 | 21 | You can show documentation for different [branches](http://inconshreveable.viewdocs.io/ngrok~master/DEVELOPMENT) or [tags](http://discourse.viewdocs.io/discourse~v0.9.6/INSTALL-ubuntu) of a repository by including a reference name after a tilde in the repository part of the path. It would look like this: 22 | 23 | http://.viewdocs.io/~ 24 | 25 | You can also customize the look and layout of your docs. Make your own `docs/template.html` based on the [default template](https://github.com/progrium/viewdocs/blob/master/docs/template.html) and your pages will be rendered with that template. If you create a `home.html` template, this will be used for your project's landing page. 26 | 27 | Redirects are supported for users who wish to move around files in their documentation structure. Simply create a `docs/viewdocs.json` file and specify your redirects like so: 28 | 29 | ```json 30 | { 31 | "redirects": { 32 | "configuration-management": "configuration/environment-variables/" 33 | } 34 | } 35 | ``` 36 | 37 | This will result in the url `/REPOSITORY/configuration-management/` being redirected to `/REPOSITORY/configuration/environment-variables/` url. 38 | 39 | I also highly recommend you [read the source](https://github.com/progrium/viewdocs/blob/master/viewdocs.go) to this app. It's less than 500 lines of Go. If you want to hack on Viewdocs, [check this out](/viewdocs/development). 40 | 41 |
42 | Enjoy!
43 | [Jeff Lindsay](http://twitter.com/progrium) 44 | -------------------------------------------------------------------------------- /docs/screen.css: -------------------------------------------------------------------------------- 1 | * { 2 | -webkit-box-sizing: border-box; 3 | -moz-box-sizing: border-box; 4 | box-sizing: border-box; } 5 | 6 | html { 7 | background-color: #fff; 8 | padding: 0; 9 | margin: 0; 10 | width: 100%; } 11 | 12 | body { 13 | width: 100%; 14 | height: 100%; 15 | padding: 1em; 16 | margin: 0; 17 | font-family: 'Sentinel SSm A', 'Sentinel SSm B', Georgia, serif; 18 | color: #444; 19 | font-weight: 300; } 20 | 21 | a { 22 | color: #4da7ca; 23 | -webkit-transition: all 0.15s ease-out 0; 24 | -moz-transition: all 0.15s ease-out 0; 25 | transition: all 0.15s ease-out 0; } 26 | a:hover, a:visited:hover { 27 | color: #296e88; } 28 | a:visited { 29 | color: #88c4dc; } 30 | 31 | .content { 32 | padding: 0.809em; 33 | max-width: 30em; 34 | margin: auto; } 35 | .content #gistid { 36 | font-weight: normal; 37 | color: #ccc; 38 | font-size: 0.8em; } 39 | .content #gistid a { 40 | color: #ccc; 41 | text-decoration: none; } 42 | .content #gistid a:hover { 43 | text-decoration: underline; } 44 | .content #description { 45 | font-family: 'Tungsten A', 'Tungsten B'; 46 | font-weight: 500; 47 | font-size: 5em; 48 | text-transform: uppercase; 49 | line-height: 1em; } 50 | .content #description.loading { 51 | -webkit-animation: throb 1s infinite alternate linear; 52 | -moz-animation: throb 1s infinite alternate linear; 53 | -ms-animation: throb 1s infinite alternate linear; 54 | -o-animation: throb 1s infinite alternate linear; } 55 | .content .apology { 56 | font-style: italic; 57 | color: #aaa; } 58 | .content > footer { 59 | margin-top: 4em; 60 | margin-bottom: 2em; 61 | border-top: 1px solid #eee; 62 | display: none; } 63 | .content > footer.forceshow { 64 | display: block; } 65 | .content > footer p { 66 | font-size: 0.8em; 67 | color: #888; 68 | font-style: italic; } 69 | .content > footer p .poweredby { 70 | display: inline-block; 71 | margin-right: 1em; } 72 | 73 | article > h1:first-child { 74 | display: none; } 75 | article h1, article h2, article h3, article h4, article h5 { 76 | font-weight: 300; 77 | margin-top: 2em; 78 | color: black; } 79 | article h1, article h2 { 80 | font-size: 1.5em; } 81 | article h3 { 82 | font-weight: 400; 83 | font-size: 0.925em; 84 | margin-top: 3em; 85 | text-transform: uppercase; } 86 | article h4, article h5, article h6 { 87 | font-weight: 400; 88 | font-size: 0.925em; 89 | margin-top: 3em; 90 | font-style: italic; } 91 | article ul, article ol { 92 | list-style-position: outside; 93 | padding: 0; } 94 | article blockquote { 95 | margin: 0; 96 | padding-left: 1em; 97 | border-left: 1px solid #ddd; } 98 | article ul, article ol, article p, article blockquote { 99 | line-height: 1.5em; } 100 | article img, article object, article video, article audio, article figure, article iframe { 101 | max-width: 100%; } 102 | article pre, article code, article samp { 103 | font-family: 'Source Code Pro', monospace; } 104 | article .highlight { 105 | padding: 0.1em 0.5em; 106 | background: #1d1f21; 107 | font-size: 0.88em; } 108 | 109 | @media all and (min-width: 33.236em) { 110 | .content { 111 | padding: 1.618em; 112 | margin: 0 auto; 113 | max-width: 45rem; 114 | font-size: 1.125em; } } 115 | @-webkit-keyframes throb { 116 | 0% { 117 | opacity: 0.25; } 118 | 119 | 100% { 120 | opacity: 1; } } 121 | 122 | @-moz-keyframes throb { 123 | 0% { 124 | opacity: 0.25; } 125 | 126 | 100% { 127 | opacity: 1; } } 128 | 129 | @-ms-keyframes throb { 130 | 0% { 131 | opacity: 0.25; } 132 | 133 | 100% { 134 | opacity: 1; } } 135 | 136 | @-o-keyframes throb { 137 | 0% { 138 | opacity: 0.25; } 139 | 140 | 100% { 141 | opacity: 1; } } 142 | 143 | .highlight .hll { 144 | background-color: #373b41; } 145 | 146 | .highlight { 147 | background: #1d1f21; 148 | color: #c5c8c6; } 149 | 150 | .highlight .c { 151 | color: #969896; } 152 | 153 | /* Comment */ 154 | .highlight .err { 155 | color: #cc6666; } 156 | 157 | /* Error */ 158 | .highlight .k { 159 | color: #b294bb; } 160 | 161 | /* Keyword */ 162 | .highlight .l { 163 | color: #de935f; } 164 | 165 | /* Literal */ 166 | .highlight .n { 167 | color: #c5c8c6; } 168 | 169 | /* Name */ 170 | .highlight .o { 171 | color: #8abeb7; } 172 | 173 | /* Operator */ 174 | .highlight .p { 175 | color: #c5c8c6; } 176 | 177 | /* Punctuation */ 178 | .highlight .cm { 179 | color: #969896; } 180 | 181 | /* Comment.Multiline */ 182 | .highlight .cp { 183 | color: #969896; } 184 | 185 | /* Comment.Preproc */ 186 | .highlight .c1 { 187 | color: #969896; } 188 | 189 | /* Comment.Single */ 190 | .highlight .cs { 191 | color: #969896; } 192 | 193 | /* Comment.Special */ 194 | .highlight .gd { 195 | color: #cc6666; } 196 | 197 | /* Generic.Deleted */ 198 | .highlight .ge { 199 | font-style: italic; } 200 | 201 | /* Generic.Emph */ 202 | .highlight .gh { 203 | color: #c5c8c6; 204 | font-weight: bold; } 205 | 206 | /* Generic.Heading */ 207 | .highlight .gi { 208 | color: #b5bd68; } 209 | 210 | /* Generic.Inserted */ 211 | .highlight .gp { 212 | color: #969896; 213 | font-weight: bold; } 214 | 215 | /* Generic.Prompt */ 216 | .highlight .gs { 217 | font-weight: bold; } 218 | 219 | /* Generic.Strong */ 220 | .highlight .gu { 221 | color: #8abeb7; 222 | font-weight: bold; } 223 | 224 | /* Generic.Subheading */ 225 | .highlight .kc { 226 | color: #b294bb; } 227 | 228 | /* Keyword.Constant */ 229 | .highlight .kd { 230 | color: #b294bb; } 231 | 232 | /* Keyword.Declaration */ 233 | .highlight .kn { 234 | color: #8abeb7; } 235 | 236 | /* Keyword.Namespace */ 237 | .highlight .kp { 238 | color: #b294bb; } 239 | 240 | /* Keyword.Pseudo */ 241 | .highlight .kr { 242 | color: #b294bb; } 243 | 244 | /* Keyword.Reserved */ 245 | .highlight .kt { 246 | color: #f0c674; } 247 | 248 | /* Keyword.Type */ 249 | .highlight .ld { 250 | color: #b5bd68; } 251 | 252 | /* Literal.Date */ 253 | .highlight .m { 254 | color: #de935f; } 255 | 256 | /* Literal.Number */ 257 | .highlight .s { 258 | color: #b5bd68; } 259 | 260 | /* Literal.String */ 261 | .highlight .na { 262 | color: #81a2be; } 263 | 264 | /* Name.Attribute */ 265 | .highlight .nb { 266 | color: #c5c8c6; } 267 | 268 | /* Name.Builtin */ 269 | .highlight .nc { 270 | color: #f0c674; } 271 | 272 | /* Name.Class */ 273 | .highlight .no { 274 | color: #cc6666; } 275 | 276 | /* Name.Constant */ 277 | .highlight .nd { 278 | color: #8abeb7; } 279 | 280 | /* Name.Decorator */ 281 | .highlight .ni { 282 | color: #c5c8c6; } 283 | 284 | /* Name.Entity */ 285 | .highlight .ne { 286 | color: #cc6666; } 287 | 288 | /* Name.Exception */ 289 | .highlight .nf { 290 | color: #81a2be; } 291 | 292 | /* Name.Function */ 293 | .highlight .nl { 294 | color: #c5c8c6; } 295 | 296 | /* Name.Label */ 297 | .highlight .nn { 298 | color: #f0c674; } 299 | 300 | /* Name.Namespace */ 301 | .highlight .nx { 302 | color: #81a2be; } 303 | 304 | /* Name.Other */ 305 | .highlight .py { 306 | color: #c5c8c6; } 307 | 308 | /* Name.Property */ 309 | .highlight .nt { 310 | color: #8abeb7; } 311 | 312 | /* Name.Tag */ 313 | .highlight .nv { 314 | color: #cc6666; } 315 | 316 | /* Name.Variable */ 317 | .highlight .ow { 318 | color: #8abeb7; } 319 | 320 | /* Operator.Word */ 321 | .highlight .w { 322 | color: #c5c8c6; } 323 | 324 | /* Text.Whitespace */ 325 | .highlight .mf { 326 | color: #de935f; } 327 | 328 | /* Literal.Number.Float */ 329 | .highlight .mh { 330 | color: #de935f; } 331 | 332 | /* Literal.Number.Hex */ 333 | .highlight .mi { 334 | color: #de935f; } 335 | 336 | /* Literal.Number.Integer */ 337 | .highlight .mo { 338 | color: #de935f; } 339 | 340 | /* Literal.Number.Oct */ 341 | .highlight .sb { 342 | color: #b5bd68; } 343 | 344 | /* Literal.String.Backtick */ 345 | .highlight .sc { 346 | color: #c5c8c6; } 347 | 348 | /* Literal.String.Char */ 349 | .highlight .sd { 350 | color: #969896; } 351 | 352 | /* Literal.String.Doc */ 353 | .highlight .s2 { 354 | color: #b5bd68; } 355 | 356 | /* Literal.String.Double */ 357 | .highlight .se { 358 | color: #de935f; } 359 | 360 | /* Literal.String.Escape */ 361 | .highlight .sh { 362 | color: #b5bd68; } 363 | 364 | /* Literal.String.Heredoc */ 365 | .highlight .si { 366 | color: #de935f; } 367 | 368 | /* Literal.String.Interpol */ 369 | .highlight .sx { 370 | color: #b5bd68; } 371 | 372 | /* Literal.String.Other */ 373 | .highlight .sr { 374 | color: #b5bd68; } 375 | 376 | /* Literal.String.Regex */ 377 | .highlight .s1 { 378 | color: #b5bd68; } 379 | 380 | /* Literal.String.Single */ 381 | .highlight .ss { 382 | color: #b5bd68; } 383 | 384 | /* Literal.String.Symbol */ 385 | .highlight .bp { 386 | color: #c5c8c6; } 387 | 388 | /* Name.Builtin.Pseudo */ 389 | .highlight .vc { 390 | color: #cc6666; } 391 | 392 | /* Name.Variable.Class */ 393 | .highlight .vg { 394 | color: #cc6666; } 395 | 396 | /* Name.Variable.Global */ 397 | .highlight .vi { 398 | color: #cc6666; } 399 | 400 | /* Name.Variable.Instance */ 401 | .highlight .il { 402 | color: #de935f; } 403 | 404 | /* Literal.Number.Integer.Long */ 405 | 406 | /* 407 | FILE ARCHIVED ON 05:50:09 Feb 20, 2019 AND RETRIEVED FROM THE 408 | INTERNET ARCHIVE ON 00:02:47 Aug 11, 2019. 409 | JAVASCRIPT APPENDED BY WAYBACK MACHINE, COPYRIGHT INTERNET ARCHIVE. 410 | 411 | ALL OTHER CONTENT MAY ALSO BE PROTECTED BY COPYRIGHT (17 U.S.C. 412 | SECTION 108(a)(3)). 413 | */ 414 | /* 415 | playback timings (ms): 416 | exclusion.robots: 0.153 417 | load_resource: 191.359 418 | RedisCDXSource: 27.217 419 | PetaboxLoader3.datanode: 211.343 (5) 420 | LoadShardBlock: 137.933 (3) 421 | esindex: 0.007 422 | exclusion.robots.policy: 0.143 423 | CDXLines.iter: 10.286 (3) 424 | captures_list: 178.089 425 | PetaboxLoader3.resolve: 112.717 (2) 426 | */ 427 | -------------------------------------------------------------------------------- /docs/template.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | {{NAME}} :: viewdocs.io 5 | 6 | 7 | 8 | 9 | 21 | 22 | 23 |
24 |
25 |
{{NAME}} :: index
26 |
27 |
28 | {{CONTENT}} 29 |
30 |
31 | 39 | 40 | 41 | 42 | 43 | 44 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/progrium/viewdocs 2 | 3 | go 1.14 4 | 5 | require ( 6 | github.com/youtube/vitess v0.0.0-20151013041645-ba320fc84593 7 | golang.org/x/net v0.0.0-20151008145043-b846920a172a 8 | gopkg.in/yaml.v2 v2.2.8 // indirect 9 | ) 10 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/youtube/vitess v0.0.0-20151013041645-ba320fc84593 h1:348rkfeq19xFtNMj+PUtlyqq1hBWXtgfSgTiNXele8w= 2 | github.com/youtube/vitess v0.0.0-20151013041645-ba320fc84593/go.mod h1:hpMim5/30F1r+0P8GGtB29d0gWHr0IZ5unS+CG0zMx8= 3 | golang.org/x/net v0.0.0-20151008145043-b846920a172a h1:r4AyojsGB9Y0Xyl2XZ86iJcY3rj1eATk765OjLub6SQ= 4 | golang.org/x/net v0.0.0-20151008145043-b846920a172a/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= 5 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= 6 | gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10= 7 | gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= 8 | -------------------------------------------------------------------------------- /viewdocs.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "bufio" 5 | "bytes" 6 | "encoding/json" 7 | "io/ioutil" 8 | "log" 9 | "net/http" 10 | "os" 11 | "path" 12 | "strings" 13 | "time" 14 | 15 | "github.com/youtube/vitess/go/cache" 16 | "golang.org/x/net/html" 17 | "gopkg.in/yaml.v2" 18 | ) 19 | 20 | // CacheCapacity is an integer of memory in megabytes 21 | // allocated for in-memory caching of processed documents 22 | const CacheCapacity = 256 * 1024 * 1024 23 | 24 | // CacheTTL is an integer of seconds that is used to 25 | // configure the length of time a document stays in the cache 26 | // raw.github.com cache TTL is ~120 27 | const CacheTTL = 60 28 | 29 | // DefaultTemplate is a string that contains the default template 30 | // when a given repository does not have it's own template 31 | var DefaultTemplate string 32 | 33 | // CacheValue is a struct that contains a processed document 34 | // and some metadata as to when that document was created 35 | type CacheValue struct { 36 | Value string 37 | CreatedAt int64 38 | } 39 | 40 | // Size is a method attached to the CacheValue struct which 41 | // returns the length of a cache entry 42 | func (cv *CacheValue) Size() int { 43 | return len(cv.Value) 44 | } 45 | 46 | type callable func() (string, error) 47 | 48 | type frontmatter struct { 49 | TemplateName string `yaml:"TemplateName"` 50 | } 51 | 52 | func getenv(key string, defaultValue string) string { 53 | value := os.Getenv(key) 54 | if value == "" { 55 | value = defaultValue 56 | } 57 | return value 58 | } 59 | 60 | func pathPrefix() string { 61 | return getenv("PATH_PREFIX", "") 62 | } 63 | 64 | func parseRequest(r *http.Request) (user, repo, ref, doc string) { 65 | hostname := strings.Split(r.Host, ".") 66 | user = getenv("GITHUB_USER", hostname[0]) 67 | path := strings.Split(r.RequestURI, "/") 68 | 69 | repoAndRef := strings.Split(path[1], "~") 70 | repo = repoAndRef[0] 71 | if len(repoAndRef) == 1 { 72 | ref = "master" 73 | } else { 74 | ref = repoAndRef[1] 75 | } 76 | 77 | if len(path) < 3 || (len(path) == 3 && strings.HasSuffix(r.RequestURI, "/")) { 78 | doc = "index.md" 79 | } else { 80 | doc = strings.Join(path[2:], "/") 81 | if strings.HasSuffix(doc, "/") { 82 | doc = doc[:len(doc)-1] 83 | } 84 | } 85 | return 86 | } 87 | 88 | func parseFrontmatter(s string, v interface{}) (string, error) { 89 | delim := "---\n" 90 | if !strings.HasPrefix(s, delim) { 91 | return s, nil 92 | } 93 | 94 | parts := strings.SplitN(s, delim, 3) 95 | if len(parts) != 3 { 96 | return s, nil 97 | } 98 | 99 | content := parts[2] 100 | if err := yaml.Unmarshal([]byte(parts[1]), v); err != nil { 101 | return s, err 102 | } 103 | return string(content), nil 104 | } 105 | 106 | func fixRelativeLinks(user, repo, doc, ref, body string) (string, error) { 107 | hostname := getenv("HOSTNAME", "viewdocs.io") 108 | repoAndRef := repo 109 | if ref != "master" { 110 | repoAndRef += "~" + ref 111 | } 112 | n, err := html.Parse(strings.NewReader(string(body))) 113 | if err != nil { 114 | return "", err 115 | } 116 | var f func(*html.Node) 117 | f = func(n *html.Node) { 118 | if n.Type == html.ElementNode && n.Data == "a" { 119 | for i, a := range n.Attr { 120 | if a.Key == "href" { 121 | hrefValue := strings.TrimPrefix(a.Val, "http://"+user+"."+hostname+"") 122 | if strings.Index(hrefValue, "/"+repo+"/") == 0 { 123 | n.Attr[i].Val = "/" + repoAndRef + "/" + strings.TrimPrefix(hrefValue, "/"+repo+"/") 124 | continue 125 | } 126 | fs := strings.Index(hrefValue, "/") 127 | fc := strings.Index(hrefValue, ":") 128 | fh := strings.Index(hrefValue, "#") 129 | if fs == 0 || fh == 0 || 130 | (fc >= 0 && fc < fs) || 131 | (fh >= 0 && fh < fs) { 132 | continue 133 | } 134 | n.Attr[i].Val = "/" + repoAndRef + "/" + hrefValue 135 | } 136 | } 137 | } 138 | for c := n.FirstChild; c != nil; c = c.NextSibling { 139 | f(c) 140 | } 141 | } 142 | f(n) 143 | b := new(bytes.Buffer) 144 | if err := html.Render(b, n); err != nil { 145 | return "", err 146 | } 147 | return b.String(), nil 148 | } 149 | 150 | func fetchTemplate(template chan string, user string, repo string, ref string, name string) { 151 | if getenv("DEBUG", "0") == "1" { 152 | pathPrefix := pathPrefix() 153 | bodyStr, err := readFile(pathPrefix + "docs/" + name + ".html") 154 | if err == nil { 155 | template <- bodyStr 156 | return 157 | } 158 | if name != "template" { 159 | bodyStr, err := readFile(pathPrefix + "docs/template.html") 160 | if err == nil { 161 | template <- bodyStr 162 | return 163 | } 164 | } 165 | } 166 | 167 | fetched := fetchURL(template, "https://raw.github.com/"+user+"/"+repo+"/"+ref+"/docs/"+name+".html") 168 | if !fetched && name != "template" { 169 | fetched = fetchURL(template, "https://raw.github.com/"+user+"/"+repo+"/"+ref+"/docs/template.html") 170 | } 171 | 172 | if !fetched { 173 | template <- DefaultTemplate 174 | } 175 | } 176 | 177 | func fetchURL(channel chan string, url string) bool { 178 | resp, err := http.Get(url) 179 | if err == nil && resp.StatusCode != 404 { 180 | body, err := ioutil.ReadAll(resp.Body) 181 | resp.Body.Close() 182 | if err == nil { 183 | channel <- string(body) 184 | return true 185 | } 186 | } 187 | 188 | return false 189 | } 190 | 191 | func fetchDoc(user, repo, ref, doc string) (string, error) { 192 | if getenv("DEBUG", "0") == "1" { 193 | pathPrefix := pathPrefix() 194 | return readFile(pathPrefix + doc) 195 | } 196 | log.Println("FETCH: https://raw.github.com/" + user + "/" + repo + "/" + ref + "/" + doc) 197 | resp, err := http.Get("https://raw.github.com/" + user + "/" + repo + "/" + ref + "/" + doc) 198 | if err != nil { 199 | return "", err 200 | } 201 | var body []byte 202 | if resp.StatusCode == 200 { 203 | body, err = ioutil.ReadAll(resp.Body) 204 | resp.Body.Close() 205 | if err != nil { 206 | return "", err 207 | } 208 | } else { 209 | resp.Body.Close() 210 | if strings.HasPrefix(doc, "docs/") { 211 | newDoc := strings.TrimPrefix(doc, "docs/") 212 | // special-case the index page 213 | if doc == "docs/index.md" { 214 | for ext := range markdownExtensions() { 215 | bodyStr, err := fetchDoc(user, repo, ref, "README"+ext) 216 | if err != nil { 217 | return bodyStr, err 218 | } 219 | } 220 | } 221 | return fetchDoc(user, repo, ref, newDoc) 222 | } 223 | body = []byte("# Page not found") 224 | } 225 | return string(body), nil 226 | } 227 | 228 | func cleanupDocLinks(bodyStr string, err error) (string, error) { 229 | if err == nil { 230 | bodyStr = strings.Replace(bodyStr, "](docs/", "](", -1) 231 | bodyStr = strings.Replace(bodyStr, "](/docs/", "](", -1) 232 | bodyStr = strings.Replace(bodyStr, ".md)", "/)", -1) 233 | bodyStr = strings.Replace(bodyStr, ".md#", "/#", -1) 234 | } 235 | return bodyStr, err 236 | } 237 | 238 | func fetchAndRenderDoc(user, repo, ref, doc string) (string, error) { 239 | if !isAsset(doc) { 240 | // https://github.com/github/markup/blob/master/lib/github/markups.rb#L1 241 | mdExts := markdownExtensions() 242 | if ok, _ := mdExts[path.Ext(doc)]; !ok { 243 | doc += ".md" 244 | } 245 | } 246 | 247 | bodyStr, err := fetchDoc(user, repo, ref, "docs/"+doc) 248 | if err != nil { 249 | return "", err 250 | } 251 | 252 | var f frontmatter 253 | bodyStr, err = parseFrontmatter(bodyStr, &f) 254 | if err != nil || f.TemplateName == "" { 255 | f.TemplateName = "template" 256 | if doc == "index.md" { 257 | f.TemplateName = "home" 258 | } 259 | } 260 | 261 | template := make(chan string) 262 | templateName := f.TemplateName 263 | templateRecv := false 264 | defer func() { 265 | if !templateRecv { 266 | <-template 267 | } 268 | }() 269 | 270 | go fetchTemplate(template, user, repo, ref, templateName) 271 | 272 | if isAsset(doc) { 273 | return bodyStr, nil 274 | } 275 | 276 | bodyStr, err = cleanupDocLinks(bodyStr, err) 277 | client := &http.Client{} 278 | req, err := http.NewRequest("POST", "https://api.github.com/markdown/raw", strings.NewReader(bodyStr)) 279 | req.Header.Add("Content-Type", "text/x-markdown") 280 | req.Header.Add("Authorization", "token "+getenv("ACCESS_TOKEN", "")) 281 | resp, err := client.Do(req) 282 | if err != nil { 283 | return "", err 284 | } 285 | 286 | body, err := ioutil.ReadAll(resp.Body) 287 | resp.Body.Close() 288 | if err != nil { 289 | return "", err 290 | } 291 | 292 | pagesClass := strings.Replace(doc, "/", "-", -1) 293 | pagesClass = pagesClass[:len(pagesClass)-len(path.Ext(pagesClass))] 294 | 295 | output := strings.Replace(<-template, "{{CONTENT}}", string(body), 1) 296 | templateRecv = true 297 | output = strings.Replace(output, "{{NAME}}", repo, -1) 298 | output = strings.Replace(output, "{{USER}}", user, -1) 299 | output = strings.Replace(output, "{{PAGE_CLASS}}", pagesClass, -1) 300 | output = strings.Replace(output, "{{REF}}", ref, -1) 301 | output = strings.Replace(output, "{{DOC}}", doc, -1) 302 | 303 | // Fix relative links 304 | output, err = fixRelativeLinks(user, repo, doc, ref, output) 305 | if err != nil { 306 | return "", err 307 | } 308 | 309 | return output, nil 310 | } 311 | 312 | func markdownExtensions() map[string]bool { 313 | return map[string]bool{ 314 | ".md": true, 315 | ".mkdn": true, 316 | ".mdwn": true, 317 | ".mdown": true, 318 | ".markdown": true, 319 | ".litcoffee": true, 320 | } 321 | } 322 | 323 | func isAsset(name string) bool { 324 | assetExts := map[string]bool{ 325 | ".appcache": true, 326 | ".bmp": true, 327 | ".css": true, 328 | ".jpg": true, 329 | ".jpeg": true, 330 | ".js": true, 331 | ".json": true, 332 | ".png": true, 333 | ".ico": true, 334 | ".gif": true, 335 | } 336 | 337 | _, ok := assetExts[path.Ext(name)] 338 | return ok 339 | } 340 | 341 | func readFile(path string) (string, error) { 342 | file, err := os.Open(path) 343 | if err != nil { 344 | return "", err 345 | } 346 | defer file.Close() 347 | 348 | var lines []string 349 | scanner := bufio.NewScanner(file) 350 | for scanner.Scan() { 351 | lines = append(lines, scanner.Text()) 352 | } 353 | return strings.Join(lines, "\n"), scanner.Err() 354 | } 355 | 356 | func cacheKey(lruCache *cache.LRUCache, key string, fn callable) (string, error) { 357 | var output string 358 | var err error 359 | doNotCache := getenv("USE_CACHE", "true") == "false" 360 | value, ok := lruCache.Get(key) 361 | if !ok || doNotCache { 362 | log.Println("CACHE MISS:", key, lruCache.StatsJSON()) 363 | output, err = fn() 364 | if err != nil { 365 | log.Println("CACHE LOOKUP FAIL:", key, lruCache.StatsJSON()) 366 | return output, err 367 | } 368 | lruCache.Set(key, &CacheValue{output, time.Now().Unix()}) 369 | log.Println("CACHE WRITE:", key, lruCache.StatsJSON()) 370 | } else { 371 | output = value.(*CacheValue).Value 372 | if time.Now().Unix()-value.(*CacheValue).CreatedAt > CacheTTL { 373 | log.Println("CACHE DELETE:", key, lruCache.StatsJSON()) 374 | lruCache.Delete(key) 375 | } 376 | } 377 | log.Println("CACHE RETURN:", key) 378 | return output, nil 379 | } 380 | 381 | func getRepositoryConfig(lruCache *cache.LRUCache, user string, repo string, ref string) (map[string]interface{}, error) { 382 | var dat map[string]interface{} 383 | key := user + ":" + repo + ":viewdocs.json:" + ref 384 | output, err := cacheKey(lruCache, key, func() (string, error) { 385 | return fetchDoc(user, repo, ref, "docs/viewdocs.json") 386 | }) 387 | if err != nil { 388 | return dat, err 389 | } 390 | if err := json.Unmarshal([]byte(output), &dat); err != nil { 391 | return dat, err 392 | } 393 | return dat, nil 394 | } 395 | 396 | func handleRedirects(w http.ResponseWriter, r *http.Request, config map[string]interface{}, user string, repo string, ref string, doc string) bool { 397 | redirectTo := "" 398 | if r.RequestURI == "/" { 399 | redirectTo = "http://progrium.viewdocs.io/viewdocs/" 400 | } 401 | if strings.Contains(r.Host, "progrium") || strings.Contains(r.Host, "dokku") { 402 | if r.RequestURI == "/dokku" || r.RequestURI == "/dokku/" { 403 | redirectTo = "https://dokku.com" 404 | } 405 | if strings.HasPrefix(r.RequestURI, "/dokku") { 406 | redirectTo = "https://dokku.com" + "/docs" + strings.TrimPrefix(r.RequestURI, "/dokku") 407 | } 408 | } 409 | if isAsset(doc) && !strings.Contains(r.Header.Get("Cache-Control"), "no-store") { 410 | redirectTo = "https://cdn.jsdelivr.net/gh/" + user + "/" + repo + "@" + ref + "/docs/" + doc 411 | } 412 | if !strings.HasSuffix(r.RequestURI, "/") { 413 | for ext := range markdownExtensions() { 414 | if strings.HasSuffix(r.RequestURI, ext) { 415 | redirectTo = strings.TrimSuffix(r.RequestURI, ext) + "/" 416 | break 417 | } 418 | } 419 | if redirectTo == "" && !isAsset(r.RequestURI) { 420 | redirectTo = r.RequestURI + "/" 421 | } 422 | } 423 | for ext := range markdownExtensions() { 424 | if strings.HasSuffix(r.RequestURI, ext+"/") { 425 | redirectTo = strings.TrimSuffix(r.RequestURI, ext+"/") + "/" 426 | break 427 | } 428 | } 429 | 430 | repoPrefix := repo 431 | if ref != "master" { 432 | repoPrefix = repo + "~" + ref 433 | } 434 | 435 | if redirectTo == "" { 436 | if redirects, ok := config["redirects"]; ok { 437 | redirectsMap, _ := redirects.(map[string]interface{}) 438 | redirect, ok := redirectsMap[doc] 439 | if ok { 440 | redirectTo = redirect.(string) 441 | if !strings.HasPrefix(redirectTo, "http://") && !strings.HasPrefix(redirectTo, "https://") { 442 | redirectTo = "/" + repoPrefix + "/" + strings.TrimSuffix(redirectTo, "/") + "/" 443 | } 444 | } 445 | } 446 | } 447 | 448 | if redirectTo != "" { 449 | log.Println("REDIRECT: ", redirectTo) 450 | http.Redirect(w, r, redirectTo, 301) 451 | return true 452 | } 453 | return false 454 | } 455 | 456 | func main() { 457 | if getenv("ACCESS_TOKEN", "") == "" { 458 | log.Fatal("ACCESS_TOKEN was not found. Read http://progrium.viewdocs.io/viewdocs/development/ for more info") 459 | } 460 | 461 | port := getenv("PORT", "8888") 462 | lru := cache.NewLRUCache(CacheCapacity) 463 | 464 | resp, err := http.Get("https://raw.github.com/progrium/viewdocs/master/docs/template.html") 465 | if err != nil || resp.StatusCode == 404 { 466 | log.Fatal("Unable to fetch default template") 467 | } 468 | body, err := ioutil.ReadAll(resp.Body) 469 | resp.Body.Close() 470 | if err != nil { 471 | log.Fatal(err) 472 | } 473 | DefaultTemplate = string(body) 474 | 475 | http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { 476 | if r.RequestURI == "/favicon.ico" { 477 | return 478 | } 479 | switch r.Method { 480 | case "GET": 481 | user, repo, ref, doc := parseRequest(r) 482 | config, _ := getRepositoryConfig(lru, user, repo, ref) 483 | redirected := handleRedirects(w, r, config, user, repo, ref, doc) 484 | if redirected { 485 | return 486 | } 487 | log.Printf("Building docs for '%s/%s' (ref: %s)", user, repo, ref) 488 | key := user + ":" + repo + ":" + doc + ":" + ref 489 | output, err := cacheKey(lru, key, func() (string, error) { 490 | return fetchAndRenderDoc(user, repo, ref, doc) 491 | }) 492 | if err != nil { 493 | w.WriteHeader(http.StatusInternalServerError) 494 | w.Write([]byte(err.Error())) 495 | return 496 | } 497 | w.Write([]byte(output)) 498 | default: 499 | w.WriteHeader(http.StatusMethodNotAllowed) 500 | } 501 | }) 502 | log.Println("Listening on port " + port) 503 | log.Fatal(http.ListenAndServe(":"+port, nil)) 504 | } 505 | -------------------------------------------------------------------------------- /viewdocs_test.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "fmt" 5 | "testing" 6 | ) 7 | 8 | func TestInvalidEnvOnDisk(t *testing.T) { 9 | var f frontmatter 10 | 11 | templateName := "potato" 12 | body := "
street
" 13 | 14 | contents := fmt.Sprintf("---\nTemplateName: %s\n---\n%s", templateName, body) 15 | 16 | str, err := parseFrontmatter(contents, &f) 17 | 18 | if err != nil { 19 | t.Errorf("Error parsing frontmatter: %v", err) 20 | } 21 | 22 | if f.TemplateName != templateName { 23 | t.Errorf("Expected TemplateName to be %q, got %q", templateName, f.TemplateName) 24 | } 25 | 26 | if str != body { 27 | t.Errorf("Expected TemplateName to be %q, got %q", body, str) 28 | } 29 | } 30 | --------------------------------------------------------------------------------