Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Command to generate GitHub Wiki #177

Open
miguelangel-dev opened this issue Aug 19, 2020 · 3 comments
Open

Command to generate GitHub Wiki #177

miguelangel-dev opened this issue Aug 19, 2020 · 3 comments
Assignees

Comments

@miguelangel-dev
Copy link
Member

Description

Currently, nef can generate markdown files given a nef Playground. Also, it lets you export your documentation to markdown files that can be consumed from Jekyll to generate a static-microsite.

As nef works with markdown, in an easy way we could add a new command wiki to generate markdown files that can be consumed from GitHub to generate a Wiki page.

Sample usage

nef wiki --project <nef Playground>

Modules

UI

  • NefWiki
  • update existing Nef module to include the new command.

Component

  • NefWiki
  • update nef module to open wiki generation to public API.

Breaking changes

@Juanpe
Copy link

Juanpe commented Aug 19, 2020

Nice feature, I would like to contribute to this :)

@miguelangel-dev
Copy link
Member Author

miguelangel-dev commented Aug 19, 2020

Assigned, you will need some PRs that are in code-review, when it has been merged into develop you could start with that feature (~end of this week)

@miguelangel-dev
Copy link
Member Author

miguelangel-dev commented Oct 1, 2020

This issue is ready to be started! ^^

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants