Beautify standard documentation page.

Question

Beautify standard documentation page.

prafulla-codes opened this issue 4 years ago · 10 comments

Enhance the output format in which the APIs are displayed in standard mode

The code of the standard output generator can be found at helpers/templateHelpers/standard folder

ℹ️ Here is a little more info about each and every file which might help you to understand the existing code.

.
├── 📂helpers
    ├──📂templateHelpers (Contains output generators in various formats)
         ├──📂standard (methods to generate standard output)
              ├── 📄createIndex.js (Function that creates index of the first page)
              ├── 📄createPageIndex.js (Function that creates and stores of sub pages)
              ├── 📄createStylesheet.js.jsFunction that creates and stores style.css in output directory)
              ├── 📄generatePages.js (Function that creates  & stores sub pages)
              ├── 📄getAPIContent.js (Function that actually returns the output of the API definition )
              ├── 📄getBaseAPIContent.js (Gets the base level api)
              ├── 📄**generateStandardDocs.js** (The main program file which calls other functions)
    ├──📄....other helper functions

For queries comment on this issue.
Feel free to play around & have fun, Happy Coding👨‍💻👩‍💻

Answer 1 · 2020-10-05T03:05:45.000Z

Hello! What do you mean by beautifying? Is there something specific you would like to be enhanced? Also, I would like to work on this issue

Answer 2 · 2020-10-05T04:39:50.000Z

Beautifying in the sense making the output documentation more attractive and user friendly

Like enhancing color combinations, improving the index, container shadows etc

Sure you can work on it, I will assign it to you😇

Answer 3 · 2020-10-05T04:58:54.000Z

Beautifying in the sense making the output documentation more attractive and user friendly

Like enhancing color combinations, improving the index, container shadows etc

Sure you can work on it, I will assign it to you

@PeppermintNDaisies
Also making the output mobile friendly can be considered 😁

Answer 4 · 2020-10-05T12:59:11.000Z

Got it! I'll se what I can do 😸

Answer 5 · 2020-10-05T13:10:19.000Z

Sure let me know if you need any help 😃

Answer 6 · 2020-10-06T23:41:21.000Z

Hello @Pika1998 ! I haven't been able to understand how to project works, in the Contributing.md it says I should just run npm run dev, but i did and it appears to work (see image), but I haven't figured out where do the exported files appear, or how can I run it in an express projects to test changes

Answer 7 · 2020-10-07T04:01:21.000Z

Hey @PeppermintNDaisies, thank you for letting me know this issue. Exported files are in the test folder

Let me know if you are facing more difficulties, I will update the contributing.md 😃

Answer 8 · 2020-10-07T04:31:05.000Z

When we run the script npm run dev we actually give server.js file as an input, which is located in test/server.js and the output is generated at test/output folder, right now you need to manually open the output file in browser

To check it against other repos you need to make a release in your forked copy and then call it in the repository workflow

(But as of now test folder acts as your repository which contains express code server.js, routes )

Answer 9 · 2020-10-07T14:48:34.000Z

Perfect! That's very helpful, thank you, I'll try it and if there's anything else I'll let you know

Answer 10 · 2020-10-11T05:45:10.000Z

Hey @PeppermintNDaisies, I have made some changes in the master branch, this message is to notify you regarding those changes since you may have to pull once again from master.

I have added unit tests in test folder and hence moved the test express files and output files in test_repository folder