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

Create docsify page #27

Merged
merged 1 commit into from
Sep 17, 2023
Merged

Create docsify page #27

merged 1 commit into from
Sep 17, 2023

Conversation

paramah
Copy link
Owner

@paramah paramah commented Sep 17, 2023

No description provided.

@paramah paramah merged commit b16e597 into master Sep 17, 2023
3 checks passed
@what-the-diff
Copy link

what-the-diff bot commented Sep 17, 2023

PR Summary

  • NoJekyll file Addition
    A .nojekyll file was added to the docs/ directory. This prevents GitHub Pages from ignoring files that start with an underscore.

  • License File Addition
    A LICENSE file was introduced to the docs/ directory, which contains the MIT License text. This allows others to freely use, change, distribute the software under certain conditions.

  • Readme File Addition
    A README.md file was added to the docs/ directory. It includes instructions on setup and editing, facilitating easier navigation and understanding for users and contributors.

  • Sidebar File Addition
    A _sidebar.md file was added to the docs/ directory. It features links to useful sections such as "README" and "Example Second Page", enhancing the documentation's navigability.

  • HomePage Creation
    An index.html file was added to the docs/ directory. It acts as a home page for the project on GitHub Pages, with configuration and script tags set up for Docsify, a tool used for quick and simple documentation websites.

  • Content Page Addition
    A second-page.md file has been included in the docs/ directory. It contains example markdown content and a Mermaid diagram, serving as a reference for similar future content pages.

@paramah paramah deleted the feature/docsify branch September 17, 2023 10:49
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.

1 participant