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.

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

fix #932 - Add embed gist instructions to Embed Files #1238

Merged

Conversation

MichaelCurrin
Copy link
Contributor

@MichaelCurrin MichaelCurrin commented Jun 21, 2020

Summary

Added gist instructions to Embed Files page. Closes #982.

Also cleaned up the grammar on the first part of the page.

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Build-related changes
  • Other, please describe:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

The PR fulfills these requirements:

  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

Other information:


  • DO NOT include files inside lib directory.

@vercel
Copy link

vercel bot commented Jun 21, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/docsify-core/docsify-preview/e2072hkyg
✅ Preview: https://docsify-previe-git-fork-michaelcurrin-docs-add-gist-to-e-12a0b8.docsify-core.vercel.app

@codesandbox-ci
Copy link

codesandbox-ci bot commented Jun 21, 2020

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit d3a049d:

Sandbox Source
serverless-microservice-gixrq Configuration

@MichaelCurrin
Copy link
Contributor Author

I'll check the live preview tomorrow - I am having internet issues today.

sy-records
sy-records previously approved these changes Jun 22, 2020
@MichaelCurrin
Copy link
Contributor Author

MichaelCurrin commented Jun 22, 2020

Can I request a small demo gist created under docsify account? Then I can have a live example I can use in my PR.

One gist with three files such as:

  • content.md
    This is a **markdown** file in a gist.
  • script.js
    console.log("This is a script in a gist");
  • README.md
    This gist is used for example content on the docs - see the [Embed Files](https://docsify.js.org/#/embed-files) section.
    

The README just being an explanation in case anyone stumbles on the gist directly.

@anikethsaha
Copy link
Member

@MichaelCurrin here you go https://gist.github.com/anikethsaha/f88893bb563bb7229d6e575db53a8c15

@MichaelCurrin
Copy link
Contributor Author

@anikethsaha Perfect, thanks! I've used your gist and done some other cleanup.

Copy link
Member

@anikethsaha anikethsaha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome , thanks

@anikethsaha anikethsaha merged commit c3d0d0d into docsifyjs:develop Jun 22, 2020
@MichaelCurrin MichaelCurrin deleted the docs-add-gist-to-embed-files branch June 23, 2020 08:55
trusktr added a commit that referenced this pull request Jul 4, 2020
* develop:
  docs: removed codefund docs and plugin (#1262)
  docs: remove bundle size from the home page and documentation (#1257)
  fix: search can not search the table header (#1256)
  fix: after setting the background image, the button is obscured (#1234)
  Fix: fixed onlycover flag in mobile (#1243)
  fix: Updated docs with instructions for installing specific version (fixes #780) (#1225)
  fix: Add error handling for missing dependencies (fixes #1210) (#1232)
  [documdocs:  deploy docsify in docker. (#1241)
  docs: Add embed gist instructions to Embed Files (fixes #932 ) (#1238)
  chore: add changelog 4.11.4
  [build] 4.11.4
  feat: added html sanitizer for remote rendering (#1128)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Show Gist In Markdown
4 participants