Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/xaprb/story.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBaron Schwartz <xaprb@users.noreply.github.com>2018-08-05 18:54:10 +0300
committerBaron Schwartz <xaprb@users.noreply.github.com>2018-08-05 18:54:10 +0300
commit0d5a7ae0976a4b1c794e129f088f91efb1919c36 (patch)
tree74f19f460828a420720048eefea4ff956d77312a /README.md
parent77255a2dd0ca555825a9ab6437a2bd9df9c2aea2 (diff)
update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 12 insertions, 9 deletions
diff --git a/README.md b/README.md
index 0681c08..b30e885 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,18 @@
# story
-This repo is a [Hugo](https://gohugo.io). It has a lot of features that might appeal to people who invest effort in their websites and blogs:
+This repo is a [Hugo theme](https://gohugo.io) 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
+engineering. It's a great way to share your writing and speaking with the world.
-- It's blog-ready as well as being ready for arbitrary single-page content.
+It has a lot of features that might appeal to 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 supports a number of features out-of-the-box, such as LaTeX math typesetting with [KaTeX](https://github.com/Khan/KaTeX), a built-in search page with [LunrJS](https://github.com/olivernn/lunr.js), and several other niceties.
-- It has built-in support for a "slides" content type, which uses [RemarkJS](https://remarkjs.com/) to build slideshows with a single Markdown document. 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 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.
-Despite that 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 theme was originally based on a website design by HTML5UP, but I grew
-dissatisfied with that, and instead designed a new
-theme based on ideas from the [ananke](https://github.com/budparr/gohugo-theme-ananke) theme.
+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.