hackmdio / hackmdio/api-client

document creation options

未关闭
#2 2 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
TypeScript
星标
19
派生
8
PR 合并指标
30 天内没有已合并 PR

描述

I'm using `codimd-cli import` to create a new document from Markdown. This is working on HackMD now (thanks!).

When importing, it looks like we need:

1. **The ability to specify which _team_ the document should be a member of.**

Right now, imported documents belong to the user. I cannot see how to import into a team.

1. **The ability to assign tags**

Regarding teams & organization, it appears the only way to organize documents _within a team_ is via tags. I think we can manage with tags for now; each Node.js working group could have its own tag. If something else is provided instead (e.g., folders), it's important that we _don't_ need to manage multiple logins or tokens.

1. **The ability to provide a custom slug (URL)**

We get a randomly-assigned URL after importing. This is a _nice-to-have_.

This stuff could also be part of an "editing" workflow, where we login, then import, then make another API call to move the document, assign tags, update the slug, etc.

贡献指南

这个仓库没有索引到贡献指南

调研方向

Start at the `codimd-cli import` entry point and trace the existing document-creation API workflow. Determine how team membership, tags, and a custom slug could be supplied during import or through subsequent editing calls; done means the supported workflow is defined and documented for all requested options.

由索引模型根据 Issue 内容生成。

评估

技术栈
typescript
领域
api, cli
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。