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.

Sign up for GitHub

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

Jump to bottom

Beautify standard documentation page. #2

Open
prafulla-codes opened this issue Sep 20, 2020 · 10 comments
Open

Beautify standard documentation page. #2

prafulla-codes opened this issue Sep 20, 2020 · 10 comments
Assignees
@peppermint-juli
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest2020
Milestone
Express AutoDocs ...

Comments

@prafulla-codes
Copy link
Owner

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👨‍💻👩‍💻
@prafulla-codes prafulla-codes added enhancement New feature or request good first issue Good for newcomers hacktoberfest2020 labels Sep 20, 2020
@peppermint-juli
Copy link

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

@prafulla-codes
Copy link
Owner Author

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😇

@prafulla-codes prafulla-codes reopened this Oct 5, 2020
@prafulla-codes
Copy link
Owner Author

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 😁

@peppermint-juli
Copy link

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

@prafulla-codes
Copy link
Owner Author

Sure let me know if you need any help 😃

@peppermint-juli
Copy link

peppermint-juli commented Oct 6, 2020 •
edited
Loading

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
image

@prafulla-codes
Copy link
Owner Author

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 😃

@prafulla-codes
Copy link
Owner Author

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 )

@peppermint-juli
Copy link

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

@prafulla-codes
Copy link
Owner Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@peppermint-juli peppermint-juli

Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest2020
Projects
None yet
Milestone
Express AutoDocs v0.0.2
Development

No branches or pull requests
2 participants
@peppermint-juli @prafulla-codes