lipp / lipp/doclets

create tool for local previews

Open
#68 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
206
Forks
12
PR merge metrics
No merged PRs in 30d

Description

should work like this:

```
$ npm install doclets -g
$ cd your-project
$ doclets preview 8090
```

this will start a webserver on localhost:8090 which shows the output doclets.io would generate

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Begin by locating the npm package's command-line entry point and the path that produces doclets.io documentation output. Verify the expected behavior from the example command, then define completion as `doclets preview 8090` starting a local server at localhost:8090 that serves the generated output.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
cli, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.