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

Create prototype NodeJS script #1

Closed
ianjennings opened this issue Jul 25, 2020 · 1 comment
Closed

Create prototype NodeJS script #1

ianjennings opened this issue Jul 25, 2020 · 1 comment

Comments

@ianjennings
Copy link
Collaborator

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 docsify compile command to generate the source
  • uploads the compiled docsify assets to s3
@ianjennings ianjennings mentioned this issue Jul 25, 2020
Closed
@ianjennings
Copy link
Collaborator Author

Also no need to compile using docsify, the way docsify works is u just need a script tag in a index.html and u can add ur config there and that takes care of all the css and js
[9:25 PM]
So barebones, what we are doing is:

  • take in a repo url
  • Return an html with docsify config filled out
<!-- index.html -->

<!DOCTYPE html>
<html>
<head>
  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  <meta name="viewport" content="width=device-width,initial-scale=1">
  <meta charset="UTF-8">
  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/themes/vue.css" />
</head>
<body>
  <div id="app"></div>
  <script>
    window.$docsify = {
      //...
    }
  </script>
  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
</body>
</html>

This was referenced Jul 25, 2020
Open
Closed
Closed
aemmadi added a commit that referenced this issue Aug 11, 2020
@aemmadi
feat(#1): serves docsify docs at /:user/:repo endpoint
42e592b
@aemmadi aemmadi closed this as completed Aug 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ianjennings @aemmadi