Profile Repo
aemmadi/A-Practical-Guide-To-Web-Development 11
A practical guide to learn web development in 2019
An easy to use simple multi-purpose discord bot for your server
Automatically generated Docsify flavored documentation sites for your markdown files!
React app that tracks progress
Unofficial API for UT Dallas Coursebook
iCycle is a novel way to encourage people to integrate recycling into their lives and live in a sustainable manner.
aemmadi/anirudhemmadi.github.io 1
My portfolio website.
aemmadi/cloudflare-summer-2021-intern-challenge 1
Challenge for cloudflare 2021 summer internship
Microsoft REST API Guidelines
push eventaemmadi/cloudflare-summer-2021-intern-challenge
commit sha 362a1ec694d026403364bdbb72c173592c0aaf39
Add files via upload
push time in 9 days
create barnchaemmadi/cloudflare-summer-2021-intern-challenge
created branch time in 9 days
created repositoryaemmadi/cloudflare-summer-2021-intern-challenge
Challenge for cloudflare 2021 summer internship
created time in 9 days
issue openedaemmadi/fastdocs
- Currently docs are generated at
/docs/:user/:repowhenever users go to/:user/:repo(then redirected). - Find a way to generate everything directly at
/:user/:repoor allow users to be able to access rendered docs even when they go to/docs/:user/:repo.
created time in 11 days
push eventaemmadi/fastdocs
commit sha a28f8ad33ee0a768609f82a2a9638a124e38132c
chore: updated branding to fastdocs
commit sha 79d6951a02556781451ae4137674f4d4076b9f2d
style: clearer documentation wording (#21)
push time in 11 days
issue openedaemmadi/fastdocs
Application crashes at invalid endpoint
- If the
:user/:repois invalid, the application times out and crashes
created time in 11 days
issue openedaemmadi/fastdocs
:userand:repovariables throughout the docs are very ambiguous
created time in 11 days
push eventaemmadi/anirudhemmadi.github.io
commit sha 8440528f87017336e39b127fdd03f30a6e58797a
feat: updated footer links
push time in a month
push eventaemmadi/anirudhemmadi.github.io
commit sha 707425617b72ab6a1251438898a47551ed81245f
feat: Updated site info
push time in a month
startedairbnb/ts-migrate
started time in a month
push eventaisutd/aisutd.github.io
commit sha 0ccf680ae6ce667e92d20c623e658f555b6017e2
Updates
push time in a month
push eventaisutd/aisutd.github.io
commit sha 4387432b32ef9e202e09280194f90cdeb8eed8b8
Disabled officer applications
push time in a month
push eventaemmadi/fastdocs
commit sha 63ac9d160ecf9d13af4317fc9fd70e5c7a43b97e
fix: repo url typo
push time in 2 months
push eventaemmadi/fastdocs
commit sha 6e6a2c4de1e64a2274e91bf7c1fdb705c050e7ee
chore: updated repo url and analytics code
commit sha 6aa67b8a22462aea6467c9feac0d4fe498c8bdfd
chore: updated repo url and analytics code
push time in 2 months
push eventaisutd/aisutd.github.io
commit sha bb8faa7c6f8476a0d1a56ca64431d3797f1be5e6
Updates
push time in 2 months
push eventaisutd/aisutd.github.io
commit sha fadf84f671233a3c0ef3e2ed5221e804f9146cf3
Added officer application link
commit sha 14240baf22c135881677d698387e54cdd936f9cf
Deploy on custom domain
push time in 2 months
issue openedaemmadi/fastdocs
Multi-file support (docs/ folder)
Add support for projects that have documentation saved inside a docs/ folder.
created time in 2 months
push eventaemmadi/anirudhemmadi.github.io
commit sha 6741fe2c5fdec6a232305ca5b38c64ee4b3b5e26
Added new project
push time in 2 months
push eventaisutd/aisutd.github.io
commit sha d11fee5ca2acbbbec405d885dd1bd588bc71633e
Create CNAME
push time in 2 months
push eventaisutd/aisutd.github.io
commit sha e89ec1a89e64b79ceacf3ff9dbd1015fe6fe9364
Updates
push time in 2 months
push eventaisutd/aisutd.github.io
commit sha e2c38588c1f692bf53f7c53b7bfdd36add2be454
Added kickoff slides link
push time in 2 months
push eventaisutd/aisutd.github.io
commit sha e74fecdd7b39b406f8396dd2ee526d96af9d0d64
Create CNAME
push time in 2 months
push eventaisutd/aisutd.github.io
commit sha a5ef9aee5c310f530d2da65cbb5e518aafcce0fb
Updates
push time in 2 months
push eventaisutd/aisutd.github.io
commit sha c4220898e50831b6eb4b9a77cbcebf238b3c11d0
Added shortlinks for ais social media
push time in 2 months
push eventaisutd/aisutd.github.io
commit sha 56074675fce53c29e1ca74929681fb5efb35137e
Create CNAME
push time in 2 months
push eventaisutd/aisutd.github.io
commit sha c18f7af9cbfb2a552bf7f249cd32ac7cecd0261f
Update README.md
push time in 2 months
push eventaisutd/aisutd.github.io
commit sha c7ed1efecfd7a3a114a32bbcbbc5d7da7c9b7d84
Create CNAME
push time in 2 months
push eventaisutd/aisutd.github.io
commit sha 9e45e468e373fea8738ec714d8c121a59ed5f063
Updates
push time in 2 months
push eventaisutd/aisutd.github.io
commit sha 7858620ea5b8939429dd42761b8bf2df1186d4ad
Updated deploy url with custom domain
commit sha 7faaf8a630c6fa38a901a863cc7239633155e30c
workaround for github routing react router links
push time in 2 months
startedrafgraph/spa-github-pages
started time in 2 months
push eventaisutd/aisutd.github.io
commit sha fa57044b44a29afc63540d80303f4aa5ec5b9bec
Create CNAME
push time in 2 months
push eventaisutd/aisutd.github.io
commit sha 051f422f5a615d4a4360c17e6f45738d1b4d963b
Uploaded local changes
commit sha 860091aae79d049b13d365a8953f4d5713111892
Updated packages
commit sha b465edb11e155d6575758f5a445cac099905b3ca
Updated README
commit sha b6b6c2c427d53b9e847efa0255476fb4e3d0b087
add events page and kickoff info
commit sha 4f8e8c6282a74441e362e3b9f5b9525e83982421
added AIM, About, Concepts pages
commit sha be316ab3b9da50444968dea50f9feab273133071
Update landing page
commit sha 679c81abe1edb45bf59cf75524f09154122ddc5f
Old Site Data
commit sha d1350d086d9918e24b27252a22d0a475d5b72328
New AIS Website UI
commit sha 97cb2e9c1658114b4b86a9aa4219588aa923fffc
placeholder image
commit sha c638f38178800135b2c787edf3034f85312e2784
Officer List
commit sha 4241da29cbb5c6d32ac265f81dc20ba3d185b115
Removed unnecessary module
commit sha 62bdbad06e9ec7ada4261b184862d72bb110835b
Added gh-pages deploy script
commit sha 1141a2471cf5cd5f7432056606610639338b7bfb
Added redirect for /live
commit sha 7b89e26bc5fddb7a63306544047cf2f0ab2bfe9f
Added new team pictures
commit sha c5e223ae414283db58a69c0ab99c5e01177b5908
Omit the build directory
commit sha 0b084d3ab55849e2ce26649991cb374e9b97ca25
Added facebook link
commit sha eb5abd5c0c3701e3ba0ddd73abaf8666acd5614c
Formatted the mission statement, and added Brian's quote
commit sha 86fac292332ff87ba926e8c369aaa4567515f84f
Updated Michael's picture
commit sha f37c5825976c05666ae8ae2ea80069640f987f7c
Merge pull request #18 from aisutd/ui-updates New UI
push time in 2 months
PR merged aisutd/aisutd.github.io
- Adds modern-react ui to website
- Current endpoints:
/about/team/events
- Re-used previous mailchimp signup form
pr closed time in 2 months
push eventaisutd/aisutd.github.io
commit sha 1141a2471cf5cd5f7432056606610639338b7bfb
Added redirect for /live
commit sha 7b89e26bc5fddb7a63306544047cf2f0ab2bfe9f
Added new team pictures
commit sha c5e223ae414283db58a69c0ab99c5e01177b5908
Omit the build directory
commit sha 0b084d3ab55849e2ce26649991cb374e9b97ca25
Added facebook link
commit sha eb5abd5c0c3701e3ba0ddd73abaf8666acd5614c
Formatted the mission statement, and added Brian's quote
commit sha 86fac292332ff87ba926e8c369aaa4567515f84f
Updated Michael's picture
push time in 2 months
PR opened aisutd/aisutd.github.io
- Adds modern-react ui to website
- Current endpoints:
/about/team/events
- Re-used previous mailchimp signup form
pr created time in 2 months
push eventaisutd/aisutd.github.io
commit sha 4241da29cbb5c6d32ac265f81dc20ba3d185b115
Removed unnecessary module
commit sha 62bdbad06e9ec7ada4261b184862d72bb110835b
Added gh-pages deploy script
push time in 2 months
push eventaisutd/aisutd.github.io
commit sha 679c81abe1edb45bf59cf75524f09154122ddc5f
Old Site Data
commit sha d1350d086d9918e24b27252a22d0a475d5b72328
New AIS Website UI
commit sha 97cb2e9c1658114b4b86a9aa4219588aa923fffc
placeholder image
commit sha c638f38178800135b2c787edf3034f85312e2784
Officer List
push time in 2 months
push eventMLH-Fellowship/fastdocs
commit sha 1745171930c7e19d8ae2455ba6729868241a20a5
chore: added google analytics to site (#8)
push time in 2 months
issue closedMLH-Fellowship/fastdocs
I like to search istockphoto.com for illustrations for logos.
IE: https://www.istockphoto.com/vector/document-line-icons-editable-stroke-pixel-perfect-for-mobile-and-web-contains-such-gm1165724477-320857570
closed time in 2 months
ianjennings
issue openedMLH-Fellowship/fastdocs
- Have ability to embed favicon and other
<meta>tags - Get paths for required data as a config parameter
created time in 2 months
push eventMLH-Fellowship/fastdocs
commit sha 7750b6cf74cfe2efa61b5fbe47575cd6626e9fd3
style: added favicon assets and general branding (#8)
push time in 2 months
push eventMLH-Fellowship/fastdocs
commit sha 8460edc15b544a63ec7a1d2967bd22fe0177cd5e
style: added logo (#8)
push time in 2 months
push eventMLH-Fellowship/fastdocs
commit sha 23210c337eb86a63c7ec55d1655bbbc816bec35d
chore: removed docsify template
push time in 2 months
push eventMLH-Fellowship/fastdocs
commit sha 40c57b7a26490dbe52693eee58a0adfeafc2f706
style: added logo (#8)
push time in 2 months
push eventaemmadi/awesome-docsify
commit sha 47c181d59f47d182eb74ebd4c1dd0b7749fdbec7
Added fastdocs.io to showcase list
push time in 2 months
💖 A curated list of awesome things related to docsify
https://docsify.js.org/#/awesome
fork in 2 months
push eventMLH-Fellowship/fastdocs
commit sha 5f74283a6aaca90fd47dda9b8181b049fa40a285
docs: updated documentation for no compile endpoint (#17)
push time in 2 months
created tagMLH-Fellowship/fastdocs
Automatically generated Docsify flavored documentation sites for your markdown files!
created time in 2 months
push eventMLH-Fellowship/fastdocs
commit sha 89a6e1a134caa52720a18107a8116a4e368281f4
docs: updated documentation for no compile endpoint (#17)
push time in 2 months
issue closedMLH-Fellowship/fastdocs
Merge compile endpoint (/compile) to /:user/:repo
- Use
res.redirect()to automatically redirect the user to the compiled docs - Use
/docs/:user/:repoto serve the docs
closed time in 2 months
aemmadi
push eventMLH-Fellowship/fastdocs
commit sha 806006df4733ec05a167a165b45c6932c0cd5464
feat: removed compile endpoint, now serves docs at :user/:repo (#17)
commit sha e228efdbf20adbbb2e4df4613cb4243abc69d233
feat: updated serving endpoint to /docs/:user/:repo (#17)
commit sha 3c270563b795ab4a2bcc572aed1f82271362a973
Merge pull request #18 from MLH-Fellowship/redirect Updated Compile and Serving Endpoints
push time in 2 months
PR merged MLH-Fellowship/fastdocs
This PR includes:
- Users can now just go to
/:user/:repo/to compile their docs, and they will be automatically redirected to the compiled docs at the/docs/:user/:repo/endpoint.
The reason for this is to account for the temp storage provided by heroku. Files are still only written if there are no compiled versions already stored on the server (reduces write operations).
pr closed time in 2 months
PR opened MLH-Fellowship/fastdocs
This PR includes:
- Users can now just go to
/:user/:repo/to compile their docs, and they will be automatically redirected to the compiled docs at the/docs/:user/:repo/endpoint.
The reason for this is to account for the temp storage provided by heroku. Files are still only written if there are no compiled versions already stored on the server (reduces write operations).
pr created time in 2 months
issue openedMLH-Fellowship/fastdocs
Merge compile endpoint (/compile) to /:user/:repo
- Use
res.redirect()to automatically redirect the user to the compiled docs - Use
/docs/:user/:repoto serve the docs
created time in 2 months
issue closedMLH-Fellowship/fastdocs
The script from #1 should be a server with one endpoint, no security.
- Make sure you cache the result
- Don't allow people to call this more than a few times per minute so it's not abused
closed time in 2 months
ianjennings
issue closedMLH-Fellowship/fastdocs
John says watch out for v4/5 switch. How do we version?
closed time in 2 months
ianjennings
issue commentMLH-Fellowship/fastdocs
Since version 5 is not released yet, we only use v4. Later on we can add a field in the config to specify the version, or just default to v4.
comment created time in 2 months
push eventaemmadi/anirudhemmadi.github.io
commit sha 5d6033a8cfff6207f69f9973aa0666cab35de9f1
Updated resume links to new fall 2020 pdf
push time in 2 months
issue openedMLH-Fellowship/fastdocs
- Upload compiled docs to s3
- Download existing docs in s3 and serve them
created time in 2 months
push eventMLH-Fellowship/fastdocs
commit sha 11cf11f0b83794a20a5e5377fd8f82c4dfb00421
feat: deploy to port in environment (#6)
commit sha 7c2b233fbb0312ad8968216b311e9861b2b6a183
chore: updated branding to fastdocs
push time in 2 months
issue closedMLH-Fellowship/fastdocs
Create a index.html for your own server
Your server from #6 should serve an index.html that explains how to use your product.
This can be identical to your readme.md. Hell, you can even serve it with docsify.
closed time in 2 months
ianjennings
issue closedMLH-Fellowship/fastdocs
Create prototype NodeJS script
Create a basic NodeJS script that:
- takes a gibhub url as input
- reads the repo by gihub URL to find the docsify folder
- runs the
docsifycompile command to generate the source - uploads the compiled docsify assets to s3
closed time in 2 months
ianjennings
issue closedMLH-Fellowship/fastdocs
App crashes when same repo is compiled twice
- Check if repo exists in
/docs/ - If it does, compare the
README.mdfiles from github repo and compiled docs - If docs are different, recompile with new readme data
- Serve the new data at same endpoint
/:user/:repo/
closed time in 2 months
aemmadi
push eventMLH-Fellowship/fastdocs
commit sha 9c3529fabbb45c51b95926c22ec4ea48fec82018
chore: added start command
push time in 2 months
push eventMLH-Fellowship/docsify-up
commit sha 621096434c063bc65f0e7798bc76b599b2fe386a
chore: updated compiled docs folder
commit sha f54b2dc18abd7018e392692ba37c8faea0544313
feat: renamed docs folder, and serve app docs at root (#7)
commit sha d0fc5c3d17286587b2c01a53c2a5bff7bc127a00
docs: initial app documentation (#7)
commit sha 2bed0b7826dc53e6c558ad424212bd1becd1bf36
Merge branch 'master' of https://github.com/MLH-Fellowship/docsify-up into app-docs
commit sha d6a35ff98d712f67e1b2cd22c944958f7c214ef4
feat: serve app docs at root endpoint (#7)
commit sha ba5792ffec497cf0ee56147d22464ec643b0c639
docs: added config and plugin documentation (#14)
commit sha 19f0927a358151720ab749264c9a6eb6061094de
chore: changed path of compiled docs to _docs (#13)
commit sha 7ad3421399a20eaee9a726e6a5d6c3c6029747b4
chore: removed .nojekyll file (#13)
commit sha 1f217f624f3b38a6f4b1b4cfa8852ba46bab95fa
Merge pull request #13 from MLH-Fellowship/app-docs Initial Documentation
commit sha 3cc51c7b2b911eb3316d703a4306dc887895811e
Merge pull request #15 from MLH-Fellowship/dev Added Documenation
push time in 2 months
push eventMLH-Fellowship/docsify-up
commit sha 621096434c063bc65f0e7798bc76b599b2fe386a
chore: updated compiled docs folder
commit sha f54b2dc18abd7018e392692ba37c8faea0544313
feat: renamed docs folder, and serve app docs at root (#7)
commit sha d0fc5c3d17286587b2c01a53c2a5bff7bc127a00
docs: initial app documentation (#7)
commit sha cb6973a41072b287aab7b8a1ee9e4aea1ed106f4
chore: updated entry point to app.js
commit sha 1ef60c5277ba46ec6c306932b79ae86756d083f5
feat: added support for custom fastdocs config (#5)
commit sha 6da2e1afaf19054db7b7995371b76bb999e5e9aa
Merge branch 'dev' of https://github.com/MLH-Fellowship/docsify-up into feat/docs-config
commit sha c793ae4c01ce1873c28780c53763a0fc4cf171af
chore: refactored function names, added basic error handling
commit sha 6ed298b8823490d33574f4ecad32bdc06530d0fd
feat: added config schema (#5)
commit sha 0a84ab78ef934a11b4149d19d2ccc9d273cac9d0
feat: added support for plugins (#2)
commit sha b29c8192f0e3244cc3620fa4d319931c9c6259f8
feat: support for major docsify plugins (#4)
commit sha 5c58e86b963b7baa2ca7275e9c2cb010d9adcf34
Merge pull request #12 from MLH-Fellowship/dev Prototype Script
commit sha 8743815ce65e141b8ea4090d95d278e1cd9d9fbc
chore: refactor, removed try catch error handling (#14)
commit sha ab32a7092f15e1d487ed22ae7135c9e4d40db6ae
chore: reduced conditional return statements (#14)
commit sha eea68ff2608a67ba67d878fee27cb56c4a1690fd
style: updated logic to determine default config (#14)
commit sha 77920abd4f73604c65298916304bc2abf0424c96
Merge pull request #14 from MLH-Fellowship/feat/docs-config Config and Plugin Support
commit sha 2bed0b7826dc53e6c558ad424212bd1becd1bf36
Merge branch 'master' of https://github.com/MLH-Fellowship/docsify-up into app-docs
commit sha d6a35ff98d712f67e1b2cd22c944958f7c214ef4
feat: serve app docs at root endpoint (#7)
commit sha ba5792ffec497cf0ee56147d22464ec643b0c639
docs: added config and plugin documentation (#14)
commit sha 19f0927a358151720ab749264c9a6eb6061094de
chore: changed path of compiled docs to _docs (#13)
commit sha 7ad3421399a20eaee9a726e6a5d6c3c6029747b4
chore: removed .nojekyll file (#13)
push time in 2 months
PR merged MLH-Fellowship/docsify-up
This PR includes:
- Getting started guide for users to understand how the service works, served at
/endpoint. - Updated path for compiles docs to
_docs/(previously just/docs/).
pr closed time in 2 months
push eventMLH-Fellowship/docsify-up
commit sha cb6973a41072b287aab7b8a1ee9e4aea1ed106f4
chore: updated entry point to app.js
commit sha 1ef60c5277ba46ec6c306932b79ae86756d083f5
feat: added support for custom fastdocs config (#5)
commit sha d1f444bace9a5de5ac1322863adf4acdadefcd18
chore: refactored code, moved functions to util (#12)
commit sha 5fe1a241fc1d9a19604f7c21024ceef4e784982d
chore: seperated html logic from express logic (#12)
commit sha 34901d4a0575e8ab923023dd84a21f3551f43249
chore: moved logic to util (#12)
commit sha 6da2e1afaf19054db7b7995371b76bb999e5e9aa
Merge branch 'dev' of https://github.com/MLH-Fellowship/docsify-up into feat/docs-config
commit sha c793ae4c01ce1873c28780c53763a0fc4cf171af
chore: refactored function names, added basic error handling
commit sha 6ed298b8823490d33574f4ecad32bdc06530d0fd
feat: added config schema (#5)
commit sha 0a84ab78ef934a11b4149d19d2ccc9d273cac9d0
feat: added support for plugins (#2)
commit sha b29c8192f0e3244cc3620fa4d319931c9c6259f8
feat: support for major docsify plugins (#4)
commit sha 5c58e86b963b7baa2ca7275e9c2cb010d9adcf34
Merge pull request #12 from MLH-Fellowship/dev Prototype Script
commit sha 8743815ce65e141b8ea4090d95d278e1cd9d9fbc
chore: refactor, removed try catch error handling (#14)
commit sha ab32a7092f15e1d487ed22ae7135c9e4d40db6ae
chore: reduced conditional return statements (#14)
commit sha eea68ff2608a67ba67d878fee27cb56c4a1690fd
style: updated logic to determine default config (#14)
commit sha 77920abd4f73604c65298916304bc2abf0424c96
Merge pull request #14 from MLH-Fellowship/feat/docs-config Config and Plugin Support
commit sha 2bed0b7826dc53e6c558ad424212bd1becd1bf36
Merge branch 'master' of https://github.com/MLH-Fellowship/docsify-up into app-docs
commit sha d6a35ff98d712f67e1b2cd22c944958f7c214ef4
feat: serve app docs at root endpoint (#7)
commit sha ba5792ffec497cf0ee56147d22464ec643b0c639
docs: added config and plugin documentation (#14)
commit sha 19f0927a358151720ab749264c9a6eb6061094de
chore: changed path of compiled docs to _docs (#13)
commit sha 7ad3421399a20eaee9a726e6a5d6c3c6029747b4
chore: removed .nojekyll file (#13)
push time in 2 months
push eventaisutd/aisutd.github.io
commit sha cdabb1256863dd221e73a18d7ced939f8b3cb0a5
Add redirect page for kick-off link TODO: Replace example.com with the live stream link
commit sha 12237d9ed9eee135fd7298b54d892965678dd019
Merge pull request #16 from aisutd/chore/live-redirect Add redirect page for kick-off link
push time in 2 months
PR merged aisutd/aisutd.github.io
TODO: Replace example.com with the live stream link
pr closed time in 2 months
push eventMLH-Fellowship/docsify-up
commit sha cb6973a41072b287aab7b8a1ee9e4aea1ed106f4
chore: updated entry point to app.js
commit sha 1ef60c5277ba46ec6c306932b79ae86756d083f5
feat: added support for custom fastdocs config (#5)
commit sha 6da2e1afaf19054db7b7995371b76bb999e5e9aa
Merge branch 'dev' of https://github.com/MLH-Fellowship/docsify-up into feat/docs-config
commit sha c793ae4c01ce1873c28780c53763a0fc4cf171af
chore: refactored function names, added basic error handling
commit sha 6ed298b8823490d33574f4ecad32bdc06530d0fd
feat: added config schema (#5)
commit sha 0a84ab78ef934a11b4149d19d2ccc9d273cac9d0
feat: added support for plugins (#2)
commit sha b29c8192f0e3244cc3620fa4d319931c9c6259f8
feat: support for major docsify plugins (#4)
commit sha 8743815ce65e141b8ea4090d95d278e1cd9d9fbc
chore: refactor, removed try catch error handling (#14)
commit sha ab32a7092f15e1d487ed22ae7135c9e4d40db6ae
chore: reduced conditional return statements (#14)
commit sha eea68ff2608a67ba67d878fee27cb56c4a1690fd
style: updated logic to determine default config (#14)
commit sha 77920abd4f73604c65298916304bc2abf0424c96
Merge pull request #14 from MLH-Fellowship/feat/docs-config Config and Plugin Support
push time in 2 months
PR merged MLH-Fellowship/docsify-up
This PR includes:
Config
- Now scans
/:user/:repofor a.fastdocs.jsonconfig file. This allows fastdocs to know which plugins to add when rendering the docs. - Defaults to rendering without config if any error is thrown during parsing the config.
Current Config:
{
"description": "Description",
"plugins": [],
"gaCode": ""
}
gaCode is only required when google-analytics is added to the plugins array
Plugins
- Added support for most major plugins on docsify that were determined to be "lightweight" enough to be added to the fastdocs microservice. These include:
docsify-copy-code: Adds a "Copy to Clipboard" next to code blocksfull-text-search: Adds a search bar on the top of the sidebar to quickly search docsgoogle-analytics: Support for google analytics- Need to provide the google analytics code inside
gaCodeon the config.
- Need to provide the google analytics code inside
emoji: Renders emoji's in your documentation. (Ex::100:would render to 💯)zoom-image: Adds subtle zooming to images cursor is hovering
pr closed time in 2 months
issue closedMLH-Fellowship/docsify-up
Take #1 and add support for "copy to clipboard" plugin that can be turned on or off with a boolean
<script src="//cdn.jsdelivr.net/npm/docsify-copy-code"></script>
closed time in 2 months
ianjennings
issue closedMLH-Fellowship/docsify-up
Have your script from #1 read a file called docsifyup.json from the repository.
This is a schema that will configure the steps from #2, #3, #4, etc.
{
name; "",
description: "",
plugins: []
theme: "dark"
}
closed time in 2 months
ianjennings
issue closedMLH-Fellowship/docsify-up
Make #2 behave like #3.
Make sure your script takes the plugin package name as a string.
Here are a list of plugins. https://github.com/docsifyjs/awesome-docsify
It's important that we don't let people specify a JS file! That would be a security hole.
closed time in 2 months
ianjennings
push eventMLH-Fellowship/docsify-up
commit sha 8743815ce65e141b8ea4090d95d278e1cd9d9fbc
chore: refactor, removed try catch error handling (#14)
commit sha ab32a7092f15e1d487ed22ae7135c9e4d40db6ae
chore: reduced conditional return statements (#14)
commit sha eea68ff2608a67ba67d878fee27cb56c4a1690fd
style: updated logic to determine default config (#14)
push time in 2 months
Pull request review commentMLH-Fellowship/docsify-up
function writeDocs(user, repo, readmeData) { }); } +async function writeDocsWithConfig(user, repo, readmeData, config) {+ try {+ Object.keys(config).forEach((key) => {+ mainConfig[`${key}`] = config[key];+ });++ mainConfig.enablePlugins = false;+ if (mainConfig.plugins.length > 0) {+ mainConfig.enablePlugins = true;+ }++ if (mainConfig.enablePlugins) {+ const pluginConfig = plugins.addPlugins(mainConfig.plugins);+ mainConfig.plugins = pluginConfig;+ }++ const htmlData = docsify.generateHtmlWithConfig(mainConfig);++ fs.writeFileSync(`./docs/${user}-${repo}/README.md`, readmeData, function (+ err+ ) {+ if (err) throw err;+ console.log("Generated ReadMe!");+ });++ fs.writeFileSync(`./docs/${user}-${repo}/index.html`, htmlData, function (+ err+ ) {+ if (err) throw err;+ console.log("Generated HTML!");+ });+ } catch (error) {+ writeDocsWithDefaultConfig(user, repo, readmeData);+ }
Hmm, interesting read. Will look more into error handling with callback functions. Future refactor!!
comment created time in 2 months
Pull request review commentMLH-Fellowship/docsify-up
+{+ "description": "Description",+ "plugins": [],+ "gaCode": ""+}
Yeah the config.json here is just the list of supported keys that can be used
comment created time in 2 months
PR opened MLH-Fellowship/docsify-up
This PR includes:
Config
- Now scans
/:user/:repofor a.fastdocs.jsonconfig file. This allows fastdocs to know which plugins to add when rendering the docs. - Defaults to rendering without config if any error is thrown during parsing the config.
Current Config:
{
"description": "Description",
"plugins": [],
"gaCode": ""
}
gaCode is only required when google-analytics is added to the plugins array
Plugins
- Added support for most major plugins on docsify that were determined to be "lightweight" enough to be added to the fastdocs microservice. These include:
docsify-copy-code: Adds a "Copy to Clipboard" next to code blocksfull-text-search: Adds a search bar on the top of the sidebar to quickly search docsgoogle-analytics: Support for google analytics- Need to provide the google analytics code inside
gaCodeon the config.
- Need to provide the google analytics code inside
emoji: Renders emoji's in your documentation. (Ex::100:would render to 💯)zoom-image: Adds subtle zooming to images cursor is hovering
pr created time in 2 months
push eventMLH-Fellowship/docsify-up
commit sha be2dec14bc5ccf9a866b34977d6eb9c2553999f3
feat: generates markdown and html files from repo readme
commit sha c41d3e71061918ea16c6231c7eeb283c70dbd514
chore: update dependencies
commit sha 3509097d051450c6cd6eb73eb89532e05799e1c3
docs: added reference template file for html
commit sha 43bc9906736926c5907b955d570d9df78256badc
chore: ignore .DS_Store
commit sha f975dfe332cbe9acd0ec081299e5f385421fe12f
feat: generates working html file with docsify
commit sha 50d00157d1e9aa19efb8a36b6d393a03b8bfc912
server /docs using express.static
commit sha 42e592b3850ecb4b27717e9ac83efc8766999b06
feat(#1): serves docsify docs at /:user/:repo endpoint
commit sha 2bae15f6027b2c06d3ba64d6dbdedf2f8c33835c
chore: added hasha package for hashing
commit sha c8cd0d93297fe49839a5e40adb7500e3f301abb4
fix(#11): added hashing to readme files, only writes new files if they are different
commit sha d1f444bace9a5de5ac1322863adf4acdadefcd18
chore: refactored code, moved functions to util (#12)
commit sha 5fe1a241fc1d9a19604f7c21024ceef4e784982d
chore: seperated html logic from express logic (#12)
commit sha 34901d4a0575e8ab923023dd84a21f3551f43249
chore: moved logic to util (#12)
commit sha 5c58e86b963b7baa2ca7275e9c2cb010d9adcf34
Merge pull request #12 from MLH-Fellowship/dev Prototype Script
push time in 2 months
PR merged MLH-Fellowship/docsify-up
This PR includes:
app.js: Script that generates docsify rendered docs and serves them- Entry point:
GET /:user/:repo/compile(Had to use/compilein the endpoint for generating and adding docsify to files)- Docs will only be updated if users go to the
/compileendpoint first. If they don't the view endpoint will keep serving the previously compiled docs. - Previously compiled docs are only overwritten after comparing the
md5hash values to determine if they new file is different or not. Assuming this saves time and write calls toS3when deployed.
- Docs will only be updated if users go to the
- View point:
GET /:user/:repo/(Serves the docsify files usingexpress.staticfor users to view)
- Entry point:
- Added new dependency:
hasha(Module that takes care of hashing functions)
pr closed time in 2 months
push eventaemmadi/Kanna-Bot
commit sha 8261424077e8cce1f6fd456aa5e3e587ea710c4a
Update .fastdocs.json
push time in 2 months
push eventaemmadi/Kanna-Bot
commit sha f10f5bc43df6e973b695a34285a65c138d13899c
Update README.md
push time in 2 months
push eventMLH-Fellowship/docsify-up
commit sha d1f444bace9a5de5ac1322863adf4acdadefcd18
chore: refactored code, moved functions to util (#12)
commit sha 5fe1a241fc1d9a19604f7c21024ceef4e784982d
chore: seperated html logic from express logic (#12)
commit sha 34901d4a0575e8ab923023dd84a21f3551f43249
chore: moved logic to util (#12)
push time in 2 months
push eventaemmadi/Kanna-Bot
commit sha b8037f9a5f4b51c1d3ce0e92be31dc3a2343243e
Update .fastdocs.json
push time in 2 months
push eventaemmadi/Kanna-Bot
commit sha 3157e82a1406aaef8a658270f029b44d36f18223
Update .fastdocs.json
push time in 2 months
push eventaemmadi/Kanna-Bot
commit sha 9442a0efcab72f625c1aa4a8ec7d4bb8da516829
Update .fastdocs.json
push time in 2 months
push eventaemmadi/Kanna-Bot
commit sha aa995e2774661e44458f15bef2c8efd461267b9c
Create .fastdocs.json
push time in 2 months