GithubHelp home page GithubHelp logo

grunt-docbase's Introduction

grunt-docbase

Grunt plugin to generate html files from your docbase project.

Getting Started

This plugin requires Grunt ~0.4.1

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-docbase --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-docbase');

The "docbase" task

Overview

In your project's Gruntfile, add a section named docbase to the data object passed into grunt.initConfig().

grunt.initConfig({
  docbase: {
    options: {
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

options.generatePath

Type: String Default value: html/

A string value that is used to create the files generated.

options.urlToAcess

Type: String Default value: http://localhost:8080/

A string value that will be crawled to generate the HTML files.

Usage Examples

Default Options

In this example, the default options are used to do something with whatever. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result would be Testing, 1 2 3.

grunt.initConfig({
  docbase: {
    options: {
      generatePath: 'html/',
      urlToAcess: 'http://localhost:8080/',
    },
    files: {
      'dest/default_options': ['src/testing', 'src/123'],
    },
  },
})

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)

grunt-docbase's People

Contributors

farhan687 avatar mateusfreira avatar siddharthlatest avatar

Stargazers

 avatar  avatar

Watchers

 avatar James Cloos avatar Avi Aryan avatar Karan Vyas avatar Lakhan Samani avatar Rishi avatar Kuldeep Saxena avatar  avatar

grunt-docbase's Issues

Need routing when url points to a version

Pick a default path when URL points to a version number or the base URL.

For eg: docs.appbase.io/v2.0/ should redirect to docs.appbase.io/v2.0/.html
and docs.appbase.io should redirect to docs.appbase.io/v2.0/.html

This could be an additional setting that can be used in grunt config file:
current doc version,
doc version: default path,
...

Grunt generated html has smaller font size

Can we see how this process could affect the fonts:

  1. Are we missing a css file?
  2. Is the grunt-compile / phantom affecting this?

In the worst case where we don't know the reason, we want to enhance the font sizes to overcome the effect.

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.