Giter Site home page Giter Site logo

Comments (4)

hramos avatar hramos commented on April 20, 2024

Here's @caabernathy's post in full, for reference:

Suggestion from my first time running the init script:

Instead of the examples script output:

Example docs created in makeitopen/docs-examples-from-docusaurus! Rename the folder to makeitopen/docs to see the example docs on your site.
Example blog posts created in makeitopen/website/blog-examples-from-docusaurus! Rename the folder to makeitopen/website/blog to see the example blog posts on your site.
Example .gitignore file created in website/.
Example Footer.js file created in website/core/.
Example help.js file created in website/pages/en/.
Example index.js file created in website/pages/en/.
Example users.js file created in website/pages/en/.
Example sidebars.json file created in website/.
Example siteConfig.js file created in website/.
Example custom.css file created in website/static/css/.
Example docusaurus.svg file created in website/static/img/.
Example favicon.png file created in website/static/img/.
Example favicon.ico file created in website/static/img/favicon/.
Example oss_logo.png file created in website/static/img/.

Wrote docusaurus scripts to package.json file.

I'd suggest something more readable and the prescriptive pieces moved to the end, ex:

Example website created:

makeitopen/
  docs-examples-from-docusaurus/
  website/
    .gitignore
    sidebars.json
    siteConfig.js
    blog-examples-from-docusaurus/
    core/
      Footer.js
    pages/
      en/
        help.js
        index.js
        users.js
    static/
      css/
        custom.css
      img/
        docusaurus.svg
        favicon.png
        oss_logo.png
        favicon/
          favicon.ico

Wrote docusaurus scripts to package.json file.

Rename makeitopen/docs-examples-from-docusaurus to makeitopen/docs to see the example docs on your site.

Rename makeitopen/website/blog-examples-from-docusaurus to makeitopen/website/blog to see the example blog posts on your site.

from docusaurus.

JoelMarcey avatar JoelMarcey commented on April 20, 2024

See #239 (comment) for additional comments about this.

from docusaurus.

endiliey avatar endiliey commented on April 20, 2024

I think this is closed by #665

I saw prettier init script when docusaurus-examples are executed
ghjk

from docusaurus.

yangshun avatar yangshun commented on April 20, 2024

Yes, nice catch. Thanks!

from docusaurus.

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.