CLI - Generator
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- javascript, node.js
- 領域
- cli, documentation
調査の方向性
Guide に記載されている CLI インストールフローと、生成された config.json の設定から始めます。ウィザードがソースとドキュメントのパスを尋ね、指定された style-guide のボイラープレートとフォルダーを作成し、localhost URL とカスタマイズ方法の案内を表示することを確認してください。
索引モデルが issue の本文から書いたものです。
説明
Create a wizard using the CLI to guide the user on how to install and do a basic setup.
Guide
Install
Install Node.js on your computer and the from the console or terminal go to your project folder and use npm to install DocumentCSS:
> cd path/to/myproject
> npm install doccss
You will then will be prompted to enter the path to the folder you want documentCSS to parse for documentation. Enter the desired location.
> Enter the path to source files to be parsed for documentation: (ex: src/styles/)
> src
Following you will be prompted to enter the path where you want to store the generated documentation. Enter the desired location.
> Enter the path to location where to store docs: (ex: src/)
> src/styles
With this information DocumentCSS will generate a style guide with boilerplate content for the Homepage and Styles pages. Use these as a reference to create more documentation.
You will then see the following message:
Access your style guide at: http://localhost:8080/docs
DocumentCSS has created for you the following:
- scr/styleguide/pages → store here documentation outside of you code using markdown files.
- scr/styleguide/theme → customize the appearance of your style guide by modifying these files.
Customize these settings in config.json
- 主要言語
- HTML
- スター
- 73
- フォーク
- 7
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
bitovi/documentcss のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
bitovi/documentcss#64 · コメント 1 件 ·
-
developer relations
難易度 4/5 3〜5日 初心者へのやさしさ 15/100
bitovi/documentcss#62 ·
-
Wrong FAQ linkオープン
難易度 1/5 1時間未満 初心者へのやさしさ 45/100
bitovi/documentcss#61 ·
-
Setup Theme Logicオープン
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
bitovi/documentcss#60 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 38/100
bitovi/documentcss#59 ·
bitovi/documentcss の issue をすべて見る
似ている issue
-
Help text refers to commands by alias or without the `pulumi` prefix, plus small wording errorsオープンBug pulumi/pulumi
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
andromarces/agent-loops#571 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
stripe/stripe-cli#2130 ·
メンテナーはふだん 1 日以内に返信
-
area/install reliability status/ready
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
CLI: TUI shows onboarding when the provider's API key is only in the environment (e.g. OPENROUTER_API_KEY)対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープンCLI
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
cline/cline#14923 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信