diff options
author | Vicky <vicky@vickylai.com> | 2017-03-13 12:14:02 +0300 |
---|---|---|
committer | Vicky <vicky@vickylai.com> | 2017-03-13 12:14:02 +0300 |
commit | 6598cf34b055c084940350dfe11d29710b5a0905 (patch) | |
tree | a6f2711122c641934fbbd45536fc4aa270ccb43e /README.md | |
parent | 1f3201fa434602db69f94fe6474610b7be08a5b8 (diff) |
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..9ca5612 --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# Introduction theme for Hugo + +A minimal, single page, smooth scrolling theme for Hugo. + +Features: +* Single scrolling home page + * About and Contact sections + * Optional Projects and Blog sections +* Browser friendly CSS fade-in effect for some pizzaz +* Smooth scroll-to nav feature +* Responsive and fast + +## Quick start + +### Get the theme + +From the root of your Hugo site: +```sh +$ cd themes +$ git clone https://github.com/vickylaixy/hugo-theme-introduction.git introduction +``` + +### Configure your site + +From the exampleSite, copy `config.toml` to the root folder of your Hugo site and change the fields as you like. + +Start with: +1. Set your baseurl +2. Set your full name and first name +3. Set your avatar image +4. Input your social site usernames +5. Choose whether or not to show the Blog and Projects sections, and configure them to your liking + +### Create About and Contact pages + +Run: +``` +$ hugo new about.md +$ hugo new contact.md +``` +Then edit the markdown files with the content you'd like shown in your main page's About and Contact sections. + +## Preview your site locally + +Use Hugo's built-in server to see your site in action as you make changes. + +``` +$ hugo -t introduction --watch serve +``` + +Visit `localhost:1313` in your browser to see a live preview of your site. + +## Blog posts + +To create a new blog post, run: +``` +$ hugo new blog/your-post.md +``` + +## License +This theme is released under the [Creative Commons Attribution 3.0 license.](https://github.com/vickylaixy/hugo-theme-introduction/blob/master/LICENSE.md)
\ No newline at end of file |