docs-ts

A zero-config documentation tool for my TypeScript projects

MIT License

Downloads
1.2K
Stars
101
Committers
7
docs-ts - 0.7.2 Latest Release

Published by gcanti over 1 year ago

remove extensions from examples/index.ts

docs-ts - 0.7.1

Published by gcanti over 1 year ago

make docs-ts compatible with typescript ^5.x

docs-ts - 0.6.10

Published by gcanti over 3 years ago

  • Bug Fix
    • fix Parser ignoring @internal/@ignored methods on classes (@IMax153)
docs-ts - 0.6.9

Published by gcanti over 3 years ago

  • Polish
    • print error as non coerced string, #28 (@waynevanson)
docs-ts - 0.6.8

Published by gcanti over 3 years ago

  • Polish
    • modules no longer require examples when enforceExamples is true (@IMax153)
docs-ts - 0.6.7

Published by gcanti over 3 years ago

  • Bug Fix
    • use strict: true in project configuration, fix #36 (@gcanti)
docs-ts - 0.6.6

Published by gcanti over 3 years ago

  • Bug Fix
    • simplify @example import replacement, #35 (@thought2)
docs-ts - 0.6.5

Published by gcanti over 3 years ago

  • Polish
    • allow double quotes in @example project imports, #31 (@thought2)
docs-ts - 0.6.4

Published by gcanti over 3 years ago

  • New Feature
    • add projectHomepage configuration property, closes #26 (@IMax153)
docs-ts - 0.6.3

Published by gcanti over 3 years ago

  • Polish
    • fix modules not respecting config settings #24 (@IMax153)
    • move prettier to peerDependencies, closes #22 (@gcanti)
docs-ts - 0.6.2

Published by gcanti over 3 years ago

  • Breaking Change

    • refactor Markdown module (@IMax153)
      • add Markdown constructors (@IMax153)
      • add tagged union of Printable types (@IMax153)
      • add fold destructor for Markdown (@IMax153)
      • add Semigroup, Monoid, and Show instances for Markdown (@IMax153)
      • add printModule helper function (@IMax153)
    • update Parser module (@IMax153)
      • add ParserEnv which extends Environment (@IMax153)
      • add Ast interface (@IMax153)
    • update Core module (@IMax153)
      • add Program and Environment types (@IMax153)
      • update Capabilities interface (@IMax153)
      • remove Eff, MonadFileSystem, and MonadLog types (@IMax153)
      • remove MonadFileSystem and MonadLog instances (@IMax153)
    • rename domain module to Module (@IMax153)
      • rename all constructors to match their respective types (@IMax153)
  • New Feature

    • add Config module (@IMax153)
      • support configuration through docs-ts.json file (@IMax153)
      • add Config, ConfigBuilder and Settings types (@IMax153)
      • add build constructor ConfigBuilder (@IMax153)
      • add resolveSettings destructor for creating Settings from a ConfigBuilder (@IMax153)
      • add combinators for manipulating a ConfigBuilder (@IMax153)
    • add FileSystem module (@IMax153)
      • add FileSystem instance (@IMax153)
      • add File constructor (@IMax153)
      • add exists, readFile, remove, search, and writeFile helper functions (@IMax153)
    • add Logger module (@IMax153)
      • add LogEntry, LogLevel, and Logger types (@IMax153)
      • add showEntry and Logger instances (@IMax153)
      • add debug, error, and info helper functions (@IMax153)
    • Add Example module (@IMax153)
      • add run helper function (@IMax153)
docs-ts - 0.5.3

Published by gcanti almost 4 years ago

  • Polish
    • add support for TypeScript 4.x, closes #19 (@gcanti)
docs-ts - 0.5.2

Published by gcanti about 4 years ago

  • Polish
    • use ts-node.cmd on windows, #15 (@mattiamanzati)
docs-ts - 0.5.1

Published by gcanti over 4 years ago

  • Bug Fix
    • should not return ignore function declarations (@gcanti)
    • should not return internal function declarations (@gcanti)
    • should output the class name when there's an error in a property (@gcanti)
docs-ts - 0.5.0

Published by gcanti over 4 years ago

  • Breaking Change
    • total refactoring (@gcanti)
docs-ts - 0.4.0

Published by gcanti over 4 years ago

  • Breaking Change
    • the signature snippets are not valid TS (@gcanti)
    • add support for class properties (@gcanti)
docs-ts - 0.3.5

Published by gcanti over 4 years ago

  • Polish
    • support any path in src in the examples, #12 (@gillchristian)
docs-ts - 0.3.4

Published by gcanti over 4 years ago

  • Polish
    • remove code from headers (@gcanti)
docs-ts - 0.3.3

Published by gcanti over 4 years ago

  • Polish
    • remove useless postfix (@gcanti)
docs-ts - 0.3.1

Published by gcanti over 4 years ago

  • Bug Fix
    • add support for default type parameters (@gcanti)
Package Rankings
Top 3.16% on Npmjs.org