Skip to content

Latest commit

 

History

History
63 lines (41 loc) · 2.42 KB

mydoc_about.md

File metadata and controls

63 lines (41 loc) · 2.42 KB
title keywords last_updated tags summary sidebar permalink folder
About the theme's author
documentation theme, jekyll, technical writers, help authoring tools, hat replacements
July 3, 2016
getting_started
I have used this theme for projects that I've worked on as a professional technical writer.
mydoc_sidebar
mydoc_about.html
mydoc

{% assign sidebar = site.data.sidebars[page.sidebar].entries %}

{{page.url}}

{% for entry in sidebar %} {% for folder in entry.folders %} {% if folder.output contains "web" %} {% for folder_title in folder.title %}

{% for pages in site.pages %}

{% assign sidebar_folder = pages.sidebar_folder %} {% if sidebar_folder == folder.title %}

{% assign language = pages.language %} {% if language == "en" %}

{% assign clean_url = page.url | remove: "/" %} {% if pages.permalink == clean_url %} current page {{pages.title}} {% endif %}

  • {{pages.title}}
  • {% endif %} {% endif %} {% endfor %} {% endfor %}

    {% endif %}

    {% endfor %} {% endfor %}

    My name is Tom Johnson, and I'm a technical writer, blogger, and podcaster based in San Jose, California. For more details, see my technical writing blog and my course on API documentation. See my blog's about page for more details about me.

    I have used this theme and variations of it for various documentation projects. This theme has undergone several major iterations, and now it's fairly stable and full of all the features that I need. You are welcome to use it for your documentation projects for free.

    I think this theme does pretty much everything that you can do with something like OxygenXML, but without the constraints of structured authoring. Everything is completely open and changeable, so if you start tinkering around with the theme's files, you can break things. But it's completely empowering as well!

    With a completely open architecture and code base, you can modify the code to make it do exactly what you want, without having to jump through all kinds of confusing or proprietary code.

    If there's a feature you need but it isn't available here, let me know and I might add it. Alternatively, if you fork the theme, I would love to see your modifications and enhancements. Thanks for using Jekyll.

    {% include links.html %}