Giter Club home page Giter Club logo

docs3's Introduction

docs3's People

Contributors

billota avatar cadar avatar derwolfe avatar doppioslash avatar ericio avatar fhunleth avatar jrdnull avatar kisom avatar macintux avatar mankykitty avatar oubiwann avatar rvirding avatar tim avatar

Watchers

 avatar  avatar  avatar

docs3's Issues

Support multiple themes for docs.lfe.io

Hell, we're using a theme derived from Bootswatch -- why not support all of them? Those who like dark can use the default; those who like light, can switch.

Tasks:

  • Take a poll on the mail list (or a ticket) and find out which other Bootswatch themes people like the most
  • Add top 2 or 3 favourite themes to source
  • Add cookie/session support
  • Add theme drop-down to top nav
  • Update other themes with new LFE sass variables

Use some form of configuration for page-building

For example, we could use lfe config files to set up pages like slate does for its one-pagers. We could also support the Jekyll-type of metadata at the beginning of Markdown files.

Regardless, we should be able to combine any of the following to easily form a single page:

  • allow .md files
  • allow html fragments
  • allow a module name (function to be determined by behaviour definition)

Part of epic lfe/docs#69

Add proto-template with top-nav

  • - Find or create a straight-up HTML + CSS Bootstrap example of this
  • - Make it top-sticky
  • - Theme it the way we want (see issue #7)
  • - Define top-nav menu items

Update CSS

So this ticket title hides a plethora of tasks ...

What it really boils down to is that the Github API docs I'd used to generate the theme for v2 isn't going to cut it for our site, generally. We'll need to take advantage of the general Bootstrap components, so basically we need to start over :-(

Here are the yak that now need to be shaved for this ticket:

  • - Add bootstrap sass source
  • - Add bootswatch Slate theme sass source
  • - Make targets for installing sass and generating CSS from sass files
  • - Update colors for LFE theme
  • - Style nav background (from hamburger) when in mobile mode
  • - Remove shadow text from primary button (but keep it on :hover and :active)
  • - Mix 100% width and content width containers
  • - Add borderless Jumbotron with tagline and image
  • - Add page-wide bar like Github theme has for main/featured links/sections
  • - Style footer
  • - Add Slate theme demo html page that we can use to check the results of our theme changes
  • - Once everything has been ported over, remove Github-API-docs-based files

Templatize mockups/examples

We need to perform the following templatization tasks:

  • Convert HTML to Exemplar S-expressions
  • Split S-Expressions into Modules
  • Convert HTML mockups to Erlydtl (Erlang Django Templates)
    • Added erlydtl as a dep
    • Create structure template with all page blocks defined
    • Create base template that inherits from structure template -- this will have the page layout HTML common to all pages
    • Use this base template to convert HTML mockup pages
      • Convert top-nav - #5
      • Convert right-nav - #4
      • Convert left-nav - #3
      • Convert single-colume page template - #6
      • Convert landing-page - #2
      • Convert 2-column page - #9
      • Convert 3-column page - #10
    • Demonstrate generation of static content from erlydtl templates

This ticket is part of epic #66

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.