├── .gitignore ├── LICENSE.md ├── README.md ├── VERSION ├── archetypes └── default.md ├── exampleSite ├── config.toml └── content │ ├── img │ └── intro-bg.svg │ └── post │ ├── first.md │ ├── second.md │ └── third.md ├── images ├── screenshot.png └── tn.png ├── layouts ├── _default │ ├── list.html │ └── single.html ├── index.html └── partials │ ├── footer.html │ ├── head.html │ ├── header.html │ ├── js.html │ ├── nav.html │ ├── services.html │ └── template.css ├── static ├── css │ ├── bootstrap.css │ ├── bootstrap.min.css │ └── landing-page.css ├── fonts │ ├── glyphicons-halflings-regular.eot │ ├── glyphicons-halflings-regular.svg │ ├── glyphicons-halflings-regular.ttf │ └── glyphicons-halflings-regular.woff └── js │ ├── bootstrap.js │ └── bootstrap.min.js └── theme.toml /.gitignore: -------------------------------------------------------------------------------- 1 | public/ 2 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2014 YOUR_NAME_HERE 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of 6 | this software and associated documentation files (the "Software"), to deal in 7 | the Software without restriction, including without limitation the rights to 8 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 9 | the Software, and to permit persons to whom the Software is furnished to do so, 10 | subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 17 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 18 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 19 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 20 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Github project landing page 2 | 3 | Github landing page is a theme for [Hugo](http://gohugo.io) to create landing pages for github projects. This theme is based on [landing-page-hugo](https://github.com/crakjie/landing-page-hugo) 4 | 5 | # Demo 6 | A demo can be find here [Swiftline](http://swiftline.github.io) 7 | 8 | # Screenshot 9 |  10 | 11 | # Costumization 12 | Check [config.toml](https://github.com/nsomar/github-project-landing-page/blob/master/exampleSite/config.toml) for available configuration. 13 | Below is a description for each of them. 14 | 15 | Project description appears after project name 16 | ``` 17 | description = "Amazing project." 18 | ``` 19 | 20 | `author_url` a link of the project author. 21 | `project_url` link to project url 22 | `project_documentation` link to project documentation 23 | 24 | ``` 25 | author_url = "http://nsomar.com" 26 | project_url = "http://github.com/swiftline/swiftline" 27 | project_documentation = "http://swiftline.github.io/docs" 28 | 29 | ``` 30 | 31 | `github_user_name` github author account name 32 | `github_project_name` github project name 33 | ``` 34 | github_project_name = "swiftline" 35 | github_user_name = "swiftline" 36 | ``` 37 | 38 | Theme colors 39 | ``` 40 | first_color="#f8f8f8" 41 | first_border_color="#e7e7e7" 42 | first_text_color="#333" 43 | 44 | second_color="white" 45 | second_text_color="#333" 46 | 47 | header_color="#f8f8f8" 48 | header_text_color="rgb(51, 51, 51)" 49 | 50 | header_link_color="#777" 51 | header_link_hover_color="rgb(51, 51, 51)" 52 | 53 | ``` 54 | 55 | -------------------------------------------------------------------------------- /VERSION: -------------------------------------------------------------------------------- 1 | 0.1 2 | -------------------------------------------------------------------------------- /archetypes/default.md: -------------------------------------------------------------------------------- 1 | +++ 2 | Description = "" 3 | Keywords = [] 4 | Tags = [] 5 | Categories = [] 6 | +++ 7 | -------------------------------------------------------------------------------- /exampleSite/config.toml: -------------------------------------------------------------------------------- 1 | baseurl = "http://swiftline.github.io" 2 | languageCode = "en-us" 3 | title = "Swiftline" 4 | 5 | [params] 6 | description = "Amazing project." 7 | author_url = "http://nsomar.com" 8 | project_url = "http://github.com/swiftline/swiftline" 9 | project_documentation = "http://swiftline.github.io/docs" 10 | github_project_name = "swiftline" 11 | github_user_name = "swiftline" 12 | 13 | first_color="#f8f8f8" 14 | first_border_color="#e7e7e7" 15 | first_text_color="#333" 16 | 17 | second_color="white" 18 | second_text_color="#333" 19 | 20 | header_color="#f8f8f8" 21 | header_text_color="rgb(51, 51, 51)" 22 | 23 | header_link_color="#777" 24 | header_link_hover_color="rgb(51, 51, 51)" 25 | -------------------------------------------------------------------------------- /exampleSite/content/img/intro-bg.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | app-icon-board 5 | Created with Sketch. 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /exampleSite/content/post/first.md: -------------------------------------------------------------------------------- 1 | +++ 2 | date = "2015-12-2T14:10:00+03:00" 3 | draft = false 4 | title = "First Post" 5 | weight = 1 6 | +++ 7 | 8 | First post 9 | Where you talk about how to install your project 10 | 11 | ``` 12 | brew install amazing-tool 13 | ``` 14 | -------------------------------------------------------------------------------- /exampleSite/content/post/second.md: -------------------------------------------------------------------------------- 1 | +++ 2 | date = "2015-12-2T14:10:00+03:00" 3 | draft = false 4 | title = "Second Post" 5 | weight = 2 6 | +++ 7 | 8 | Second post 9 | Usage maybe? 10 | 11 | ``` 12 | DoSomething() 13 | ``` 14 | 15 | And the output would be: 16 | 17 | ``` 18 | Something 19 | ``` 20 | -------------------------------------------------------------------------------- /exampleSite/content/post/third.md: -------------------------------------------------------------------------------- 1 | +++ 2 | date = "2015-12-2T14:10:00+03:00" 3 | draft = false 4 | title = "Third Post" 5 | weight = 3 6 | +++ 7 | 8 | Third post 9 | Get help 10 | 11 | - Ask questions here .... 12 | - Read this doc file 13 | - Concat me twitter [@ifnottrue](https://twitter.com/@ifnottrue) 14 | -------------------------------------------------------------------------------- /images/screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nsomar/github-project-landing-page/b639b771b6b799629a7e7e9b4ab068bcda423d7c/images/screenshot.png -------------------------------------------------------------------------------- /images/tn.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nsomar/github-project-landing-page/b639b771b6b799629a7e7e9b4ab068bcda423d7c/images/tn.png -------------------------------------------------------------------------------- /layouts/_default/list.html: -------------------------------------------------------------------------------- 1 | {{ partial "head.html" . }} 2 | {{ partial "header.html" . }} 3 | {{ partial "services.html" . }} 4 | {{ partial "footer.html" . }} 5 | -------------------------------------------------------------------------------- /layouts/_default/single.html: -------------------------------------------------------------------------------- 1 | {{ partial "head.html" . }} 2 | {{ partial "nav.html" . }} 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | {{ .Title }} 14 | {{ .Content }} 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | {{ partial "footer.html" . }} 23 | -------------------------------------------------------------------------------- /layouts/index.html: -------------------------------------------------------------------------------- 1 | {{ partial "head.html" . }} 2 | {{ partial "nav.html" . }} 3 | {{ partial "header.html" . }} 4 | {{ partial "services.html" . }} 5 | {{ partial "footer.html" . }} 6 | -------------------------------------------------------------------------------- /layouts/partials/footer.html: -------------------------------------------------------------------------------- 1 | 2 | 16 | {{ partial "js.html" . }} 17 |