Git Product home page Git Product logo

typedoc-markdown-theme's Introduction

typedoc-markdown-theme's People

Contributors

kimamula avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

typedoc-markdown-theme's Issues

Single page document

Hello, will this work to create a single page of documentation? Akin to the typedoc "minimal" theme?

Getting error when building

/node_modules/typescript/lib /Users/alihabibzadeh/dc-web-api/node_modules/typedoc/dist/lib/output/renderer.js:100 throw new Error("Exception while loading \"" + filename + "\". You must export a new Theme(renderer, basePath) compatible class.\n" + ^

`Optional` prefix

May I suggest to add optional keyword after attribute name in parenthesis.

Please see screenshot below. optional word it is in title, and therefore added to vuepress menu (maybe in other templates too) as "Optional comment", which ruins alphabetical order and also may cause misunderstanding that attribute name is Optionalcomment

image

Regards,

Output has wrong extension

I'm getting files with md formatting, but extensions are still .html

Eg: My index.html, NOT index.md looks like this (markdown):

It's very easy to make some words **bold** and other words *italic* with Markdown. You can even [link to Google!](http://google.com)
Sometimes you want numbered lists:
1. One
2. Two
3. Three
Sometimes you want bullet points:
* Start a line with a star
* Profit!
Alternatively,
- Dashes work just as well
- And if you have sub points, put two spaces before the dash or star:
- Like this
- And this
If you want to embed images, this is how you do it:
![Image of Yaktocat](https://octodex.github.com/images/yaktocat.png)

how should I build the theme?

When I run npm install it fails on bundle.d.ts not found. Here's the full log:

npm WARN prepublish-on-install As of npm@5, `prepublish` scripts are deprecated.
npm WARN prepublish-on-install Use `prepare` for build steps and `prepublishOnly` for upload-only.
npm WARN prepublish-on-install See the deprecation note in `npm help scripts` for more information.

> [email protected] prepublish /Users/****/dev/playground/typedoc/typedoc-markdown-theme
> npm test && mv ./src/theme.js ./bin


> [email protected] test /Users/****/dev/playground/typedoc/typedoc-markdown-theme
> tsc && nodeunit ./test

error TS6053: File 'typings/bundle.d.ts' not found.
npm ERR! Test failed.  See above for more details.
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] prepublish: `npm test && mv ./src/theme.js ./bin`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] prepublish script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/****/.npm/_logs/2017-11-13T13_10_29_639Z-debug.log

What am I doing wrong?
I'm new to typescript, so sorry if I miss something obvious.

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.