Config and Plugin Support #14
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…to feat/docs-config
This was
linked to
issues
Aug 18, 2020
Closed
Closed
Closed
ianjennings
requested changes
Aug 19, 2020
app.js
Outdated
Comment on lines
14
to
23
| try { | ||
| util.compileDocs(user, repo).then(() => { | ||
| util.serveDocs(app, user, repo); | ||
| res.send(`Successfully Compiled Docs! View them at /${user}/${repo}`); | ||
| }); | ||
| } catch (error) { | ||
| res.send( | ||
| `Oops. We couldn't render these docs. Check your config if you have one and try again!` | ||
| ); | ||
| } |
There was a problem hiding this comment.
Does compileDocs have an error handler? That would be better than try / catch
Comment on lines
+1
to
+5
| { | ||
| "description": "Description", | ||
| "plugins": [], | ||
| "gaCode": "" | ||
| } |
There was a problem hiding this comment.
The pull request description says this isn'' required right? Is this an example?
There was a problem hiding this comment.
Yeah the config.json here is just the list of supported keys that can be used
Comment on lines
+57
to
+89
| 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); | ||
| } |
There was a problem hiding this comment.
try/catch is not a best practice.
https://softwareengineering.stackexchange.com/questions/144326/try-catch-in-javascript-isnt-it-a-good-practice
There was a problem hiding this comment.
Hmm, interesting read. Will look more into error handling with callback functions. Future refactor!!
aemmadi
added a commit
that referenced
this pull request
Aug 19, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR includes:
Config
/:user/:repofor a.fastdocs.jsonconfig file. This allows fastdocs to know which plugins to add when rendering the docs.Current Config:
{ "description": "Description", "plugins": [], "gaCode": "" }gaCodeis only required whengoogle-analyticsis added to thepluginsarrayPlugins
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 analyticsgaCodeon the config.emoji: Renders emoji's in your documentation. (Ex::100:would render to 💯)zoom-image: Adds subtle zooming to images cursor is hovering