Code Monkey home page Code Monkey logo

aws-cdk-typescript-dash-docset's Introduction

aws-cdk-typescript-dash-docset

Generate an AWS CDK Typescript docset for Dash or Zeal, based on the published docs on docs.aws.amazon.com

How to use it

This code depends on Python 3, plus a number of libraries. You can install Python with asdf by running asdf install, or you can manage that by other means.

  1. Install a compatible version of Python:

    $ asdf install
  2. Install packages:

    pip install -r requirements.txt
  3. Run ./gen_docset.sh

How it works

Step 1: Scrape all the docs from Amazon (Bash script)

This step uses wget --recursive to find and download all the docs from docs.aws.amazon.com. It may take a while.

Step 2: Munge the docs into a Dash-friendly form (Python script)

There are a few things going on here:

  • Removing unwanted tags from the HTML (for example, we don't need <script> tags or unsightly headers in Dash)
  • Building up an index of all the programming constructs for Dash to search through (as per the instructions here)
  • Structuring it all as a .docset folder, ready for Dash to import

aws-cdk-typescript-dash-docset's People

Contributors

huyphan avatar lucaswilric avatar

Stargazers

 avatar

Watchers

 avatar  avatar

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.