Git Product home page Git Product logo

Comments (5)

4meta5 avatar 4meta5 commented on May 27, 2024 1

I would rather reorganize the content to use the module-template so I'll do that with rustdoc. I think this is the right approach.

from recipes.

4meta5 avatar 4meta5 commented on May 27, 2024

Just saw this, odd that I wasn't notified earlier. I'll look into migrating to Docusaurus this weekend. I'm reorganizing a lot of the content and using the module-template to yield compileable code samples.

I guess the main advantage of using mdbook is that I'm comfortable with it.

You can also build custom backends with mdbook which might be useful in the future, although I have not yet explored this...

from recipes.

shawntabrizi avatar shawntabrizi commented on May 27, 2024

Well before you spend time on the weekend I think it would be good to come up with a final plan. For example, if you are reorganizing content to use the module-template, then it makes sense to use rustdoc right?

And have all the comments and teachings be inline to the code?

Otherwise, I saw that your project is just a bunch of MD files, which should be able to just copy and paste into docusaurus.

from recipes.

4meta5 avatar 4meta5 commented on May 27, 2024

todo

  • get compilation on all existing recipes and organize them into separate folder
  • add doc comments and render with rustdoc
  • add unit tests?

from recipes.

4meta5 avatar 4meta5 commented on May 27, 2024

I think the current approach (mdbook + kitchen) makes sense. I'm closing this because mdbook works and we can provide a kitchen with compiled examples. I'll open another issue for showing the recipes on the README along with whether the builds work (via travis) AND putting links to the compiled recipe in each section.

from recipes.

Related Issues (20)

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.