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

[how-do] make html docs pages based on custom functions #12847

Open
c4lliope opened this issue May 12, 2024 · 1 comment
Open

[how-do] make html docs pages based on custom functions #12847

c4lliope opened this issue May 12, 2024 · 1 comment
Labels
question the issue author asks something

Comments

@c4lliope
Copy link

Hello! Earlier i made some changes in nushell's docs, they had been declined because many docs pages are made procedurally.

I prepared around 8 modules in nushell code, for daily use. Each one is led by a prefix like "screen" or "disc" or "share". Id like html pages describing each command, so people can see the functions included before cloning my code.

How does nushell make such nice html docs? Can i repurpose the process around my nu code?

@IanManske
Copy link
Member

It looks like we generate the docs using the make_docs.nu script. The initial list of commands is generated in main using the scope commands command. Each command is then eventually passed to the command-doc function which actually builds the html. Hope this helps!

@IanManske IanManske added the question the issue author asks something label May 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question the issue author asks something
Projects
None yet
Development

No branches or pull requests

2 participants