From a8c23c421d1027b8efe22134d045259d49fe14ff Mon Sep 17 00:00:00 2001 From: tindli Date: Tue, 18 Aug 2015 22:52:05 +0200 Subject: [PATCH] fixed TOC --- README.md | 247 ++++++++++++++++++------------------------------------ 1 file changed, 80 insertions(+), 167 deletions(-) diff --git a/README.md b/README.md index 463648187..674ef38fd 100644 --- a/README.md +++ b/README.md @@ -1,99 +1,3 @@ - - -**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* - -- [Sample Code](#sample-code) -- [Hello](#hello) -- [Hello](#hello-1) -- [Hello](#hello-2) -- [Table of Contents](#table-of-contents) -- [Installation](#installation) -- [Another Templating Language?](#another-templating-language) -- [Design Philosophy](#design-philosophy) -- [Usage](#usage) - - [Template Loading](#template-loading) - - [Template Rendering](#template-rendering) - - [Callback API](#callback-api) - - [Streaming API](#streaming-api) - - [Synchronous API](#synchronous-api) - - [Asynchronous Rendering API](#asynchronous-rendering-api) - - [Browser-side Rendering](#browser-side-rendering) - - [Using Lasso.js](#using-lassojs) - - [Using Browserify](#using-browserify) - - [Template Compilation](#template-compilation) - - [Sample Compiled Template](#sample-compiled-template) - - [Hot reloading templates](#hot-reloading-templates) -- [Language Guide](#language-guide) - - [Template Directives Overview](#template-directives-overview) - - [Text Replacement](#text-replacement) - - [Expressions](#expressions) - - [Includes](#includes) - - [Variables](#variables) - - [Conditionals](#conditionals) - - [if...else-if...else](#ifelse-ifelse) - - [Shorthand Conditionals](#shorthand-conditionals) - - [Conditional Attributes](#conditional-attributes) - - [Looping](#looping) - - [for](#for) - - [Loop Status Variable](#loop-status-variable) - - [Loop Separator](#loop-separator) - - [Range Looping](#range-looping) - - [Property Looping](#property-looping) - - [Custom Iterator](#custom-iterator) - - [Macros](#macros) - - [def](#def) - - [invoke](#invoke) - - [Structure Manipulation](#structure-manipulation) - - [attrs](#attrs) - - [body-only-if](#body-only-if) - - [Comments](#comments) - - [Whitespace](#whitespace) - - [Helpers](#helpers) - - [Global Properties](#global-properties) - - [Custom Tags and Attributes](#custom-tags-and-attributes) - - [Async Taglib](#async-taglib) - - [Layout Taglib](#layout-taglib) -- [API](#api) - - [require('marko')](#requiremarko) - - [Methods](#methods) - - [load(templatePath[, options]) : Template](#loadtemplatepath-options--template) - - [createWriter([stream]) : AsyncWriter](#createwriterstream--asyncwriter) - - [render(templatePath, templateData, stream.Writable)](#rendertemplatepath-templatedata-streamwritable) - - [render(templatePath, templateData, callback)](#rendertemplatepath-templatedata-callback) - - [stream(templatePath, templateData) : stream.Readable](#streamtemplatepath-templatedata--streamreadable) - - [Properties](#properties) - - [helpers](#helpers) - - [Template](#template) - - [Template](#template-1) - - [Methods](#methods-1) - - [renderSync(templateData) : String](#rendersynctemplatedata--string) - - [render(templateData, stream.Writable)](#rendertemplatedata-streamwritable) - - [render(templateData, AsyncWriter)](#rendertemplatedata-asyncwriter) - - [render(templateData, callback)](#rendertemplatedata-callback) - - [stream(templateData) : stream.Readable](#streamtemplatedata--streamreadable) -- [Custom Taglibs](#custom-taglibs) - - [Tag Renderer](#tag-renderer) - - [marko-taglib.json](#marko-taglibjson) - - [Sample Taglib](#sample-taglib) - - [Defining Tags](#defining-tags) - - [Defining Attributes](#defining-attributes) - - [Scanning for Tags](#scanning-for-tags) - - [Nested Tags](#nested-tags) - - [Taglib Discovery](#taglib-discovery) -- [Frequently Asked Questions (FAQ)](#frequently-asked-questions-faq) -- [Additional Resources](#additional-resources) - - [Further Reading](#further-reading) - - [Screencasts](#screencasts) - - [Sample Apps](#sample-apps) - - [Tools](#tools) -- [Changelog](#changelog) -- [Discuss](#discuss) -- [Maintainers](#maintainers) -- [Contribute](#contribute) -- [License](#license) - - - ![Marko Logo](https://raw.githubusercontent.com/marko-js/branding/master/marko-logo-small.png) [![Build Status](https://travis-ci.org/marko-js/marko.svg?branch=master)](https://travis-ci.org/marko-js/marko) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/marko-js/marko?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) @@ -193,91 +97,100 @@ app.get('/profile', function(req, res) { # Table of Contents + + + + - [Installation](#installation) - [Another Templating Language?](#another-templating-language) +- [Hello](#hello) +- [Hello](#hello-1) +- [Hello](#hello-2) - [Design Philosophy](#design-philosophy) - [Usage](#usage) - - [Template Loading](#template-loading) - - [Template Rendering](#template-rendering) - - [Callback API](#callback-api) - - [Streaming API](#streaming-api) - - [Synchronous API](#synchronous-api) - - [Asynchronous Rendering API](#asynchronous-rendering-api) - - [Browser-side Rendering](#browser-side-rendering) - - [Using Lasso.js](#using-lassojs) - - [Using Browserify](#using-browserify) - - [Template Compilation](#template-compilation) - - [Sample Compiled Template](#sample-compiled-template) - - [Hot reloading templates](#hot-reloading-templates) + - [Template Loading](#template-loading) + - [Template Rendering](#template-rendering) + - [Callback API](#callback-api) + - [Streaming API](#streaming-api) + - [Synchronous API](#synchronous-api) + - [Asynchronous Rendering API](#asynchronous-rendering-api) + - [Browser-side Rendering](#browser-side-rendering) + - [Using Lasso.js](#using-lassojs) + - [Using Browserify](#using-browserify) + - [Template Compilation](#template-compilation) + - [Sample Compiled Template](#sample-compiled-template) + - [Hot reloading templates](#hot-reloading-templates) - [Language Guide](#language-guide) - - [Template Directives Overview](#template-directives-overview) - - [Text Replacement](#text-replacement) - - [Expressions](#expressions) - - [Includes](#includes) - - [Variables](#variables) - - [Conditionals](#conditionals) - - [if...else-if...else](#ifelse-ifelse) - - [Shorthand Conditionals](#shorthand-conditionals) - - [Conditional Attributes](#conditional-attributes) - - [Looping](#looping) - - [for](#for) - - [Loop Status Variable](#loop-status-variable) - - [Loop Separator](#loop-separator) - - [Range Looping](#range-looping) - - [Property Looping](#property-looping) - - [Custom Iterator](#custom-iterator) - - [Macros](#macros) - - [def](#def) - - [invoke](#invoke) - - [Structure Manipulation](#structure-manipulation) - - [attrs](#attrs) - - [body-only-if](#body-only-if) - - [Comments](#comments) - - [Whitespace](#whitespace) - - [Helpers](#helpers) - - [Global Properties](#global-properties) - - [Custom Tags and Attributes](#custom-tags-and-attributes) - - [Async Taglib](#async-taglib) - - [Layout Taglib](#layout-taglib) + - [Template Directives Overview](#template-directives-overview) + - [Text Replacement](#text-replacement) + - [Expressions](#expressions) + - [Includes](#includes) + - [Variables](#variables) + - [Conditionals](#conditionals) + - [if...else-if...else](#ifelse-ifelse) + - [Shorthand Conditionals](#shorthand-conditionals) + - [Conditional Attributes](#conditional-attributes) + - [Looping](#looping) + - [for](#for) + - [Loop Status Variable](#loop-status-variable) + - [Loop Separator](#loop-separator) + - [Range Looping](#range-looping) + - [Property Looping](#property-looping) + - [Custom Iterator](#custom-iterator) + - [Macros](#macros) + - [def](#def) + - [invoke](#invoke) + - [Structure Manipulation](#structure-manipulation) + - [attrs](#attrs) + - [body-only-if](#body-only-if) + - [Comments](#comments) + - [Whitespace](#whitespace) + - [Helpers](#helpers) + - [Global Properties](#global-properties) + - [Custom Tags and Attributes](#custom-tags-and-attributes) + - [Async Taglib](#async-taglib) + - [Layout Taglib](#layout-taglib) - [API](#api) - - [require('marko')](#requiremarko) - - [Methods](#methods) - - [load(templatePath[, options]) : Template](#loadtemplatepath-options--template) - - [createWriter([stream]) : AsyncWriter](#createwriterstream--asyncwriter) - - [render(templatePath, templateData, stream.Writable)](#rendertemplatepath-templatedata-streamwritable) - - [render(templatePath, templateData, callback)](#rendertemplatepath-templatedata-callback) - - [stream(templatePath, templateData) : stream.Readable](#streamtemplatepath-templatedata--streamreadable) - - [Properties](#properties) - - [helpers](#helpers) - - [Template](#template) - - [Template](#template-1) - - [Methods](#methods-1) - - [renderSync(templateData) : String](#rendersynctemplatedata--string) - - [render(templateData, stream.Writable)](#rendertemplatedata-streamwritable) - - [render(templateData, AsyncWriter)](#rendertemplatedata-asyncwriter) - - [render(templateData, callback)](#rendertemplatedata-callback) - - [stream(templateData) : stream.Readable](#streamtemplatedata--streamreadable) + - [require('marko')](#requiremarko) + - [Methods](#methods) + - [load(templatePath[, options]) : Template](#loadtemplatepath-options--template) + - [createWriter([stream]) : AsyncWriter](#createwriterstream--asyncwriter) + - [render(templatePath, templateData, stream.Writable)](#rendertemplatepath-templatedata-streamwritable) + - [render(templatePath, templateData, callback)](#rendertemplatepath-templatedata-callback) + - [stream(templatePath, templateData) : stream.Readable](#streamtemplatepath-templatedata--streamreadable) + - [Properties](#properties) + - [helpers](#helpers) + - [Template](#template) + - [Template](#template-1) + - [Methods](#methods-1) + - [renderSync(templateData) : String](#rendersynctemplatedata--string) + - [render(templateData, stream.Writable)](#rendertemplatedata-streamwritable) + - [render(templateData, AsyncWriter)](#rendertemplatedata-asyncwriter) + - [render(templateData, callback)](#rendertemplatedata-callback) + - [stream(templateData) : stream.Readable](#streamtemplatedata--streamreadable) - [Custom Taglibs](#custom-taglibs) - - [Tag Renderer](#tag-renderer) - - [marko-taglib.json](#marko-taglibjson) - - [Sample Taglib](#sample-taglib) - - [Defining Tags](#defining-tags) - - [Defining Attributes](#defining-attributes) - - [Scanning for Tags](#scanning-for-tags) - - [Nested Tags](#nested-tags) - - [Taglib Discovery](#taglib-discovery) -- [FAQ](#faq) + - [Tag Renderer](#tag-renderer) + - [marko-taglib.json](#marko-taglibjson) + - [Sample Taglib](#sample-taglib) + - [Defining Tags](#defining-tags) + - [Defining Attributes](#defining-attributes) + - [Scanning for Tags](#scanning-for-tags) + - [Nested Tags](#nested-tags) + - [Taglib Discovery](#taglib-discovery) +- [Frequently Asked Questions (FAQ)](#frequently-asked-questions-faq) - [Additional Resources](#additional-resources) - - [Further Reading](#further-reading) - - [Screencasts](#screencasts) - - [Demo Apps](#demo-apps) - - [Tools](#tools) + - [Further Reading](#further-reading) + - [Screencasts](#screencasts) + - [Sample Apps](#sample-apps) + - [Tools](#tools) - [Changelog](#changelog) - [Discuss](#discuss) - [Maintainers](#maintainers) - [Contribute](#contribute) - [License](#license) + + # Installation To install the `marko` module into your project you should use the following command: