Giter Club home page Giter Club logo

swiftdocumentationusingjazzy's Introduction

SwiftDocumentationUsingJazzy

Generate Documentation using Jazzy for Swift Projects

Example project to demonstrate the documentation generation using Jazzy, contains a sample .jazzy.yaml https://github.com/SumitKr88/SwiftDocumentationUsingJazz/

Steps:

  1. Add comments in Xcode
  2. Setup & install Jazzy
  3. Create .jazzy.yaml
  4. Configure .jazzy.yaml as per your project details
  5. Go to Terminal and type jazzy from your project folder
  6. Jazzy will start generating the document

Follow this link for details

https://medium.com/@sumit16.kumar/document-generation-for-swift-projects-using-jazzy-e148efc72bca

Having trouble ?

If you are having trouble with this project or if you find any bugs, do open a new issue and describe the problem.

Spread the word!

Liked the project? Just give it a star ⭐️ and spread the word!

Author/ Credits

© Sumit Kumar | @SumitKr88

License

MIT License

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.