diff options
| author | Baron Schwartz <xaprb@users.noreply.github.com> | 2018-09-02 06:10:58 +0300 |
|---|---|---|
| committer | Baron Schwartz <xaprb@users.noreply.github.com> | 2018-09-02 06:10:58 +0300 |
| commit | 8e5a9813b1a0a4c7342089bd9d0b38fc340721ed (patch) | |
| tree | 551c6bcd1bfbf34ec6ddae36b8648cb8feaa3914 /README.md | |
| parent | 12973262433a1c03d8fe6dbc10310aa70a4e0474 (diff) | |
getting readier to submit to theme directory
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 15 insertions, 12 deletions
@@ -1,18 +1,21 @@ -# story +# Story -This repo is a [Hugo theme](https://gohugo.io) targeted to technical writers and +Story is a beautiful [Hugo theme](https://gohugo.io) for showcasing your writing +and presentations. + + + +Story is targeted to technical writers and speakers: people such as software engineers and open source developers, who want a -website that showcases their technical work, such as blogging about software +website for their technical work, such as blogging about software engineering. It's a great way to share your writing and speaking with the world. -It has a lot of features that might appeal to people who invest effort in their websites and blogs: +It has a lot of features for people who invest effort in their websites and blogs! -- It's designed for long-form content, including blogs and single pages. -- It's simple and clean, but has features to add a little more visual appeal, such as header images to add mood/illustration to content. -- It has native support for [RemarkJS slides](https://remarkjs.com/) to build presentations in Markdown. It not only makes RemarkJS easy, but it adds other features to RemarkJS such as QR code support for easy distribution of slides (no more "can you mail me your slides"), a RemarkJS theme that adds most-needed features like two-column layouts, and content types needed to integrate slideshows into your site nicely: each presentation can have a full-featured "talks" companion page, as well as the slides themselves. -- It supports a number of features out-of-the-box, such as LaTeX math typesetting with [KaTeX](https://github.com/Khan/KaTeX), and a built-in search page with [LunrJS](https://github.com/olivernn/lunr.js). -- It's "social native" with all the tags and metadata to make it highly shareable on social media sites, as well as being "tech native" with RSS feeds and the like. -- It's optimized for print output, so articles will print beautifully to paper or PDF while also looking great on screen. -- It's mobile-first and responsive, designed for readability and clarity on any screen size or resolution from a smartphone to a large display, whether high-resolution ("Retina") or low-resolution. +- Beautiful, responsive typography for long-form content on screen and in print, including blogs and single pages. +- Support for [RemarkJS slides](https://remarkjs.com/). +- LaTeX math typesetting with [KaTeX](https://github.com/Khan/KaTeX) +- A built-in search page with [LunrJS](https://github.com/olivernn/lunr.js). -Although it's pretty rich and robust, it's also work in progress, and I would appreciate any pull requests. See the issues for the ideas I have planned for it. +This is just a fraction of Story's feature set, see the demo site for much more +documentation and screenshots. |