Comments (4)
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.
See #239 (comment) for additional comments about this.
from docusaurus.
I think this is closed by #665
I saw prettier init script when docusaurus-examples are executed
from docusaurus.
Yes, nice catch. Thanks!
from docusaurus.
Related Issues (20)
- Usage of polyfill configuration throws error HOT 6
- Code block highlighting in combination with showLineNumbers not rendering correctly HOT 1
- TOC items don't show words when they come from components HOT 2
- TOC shows comments in headings HOT 2
- HTML email addresses get rendered as nested links, ignoring `href` attribute HOT 2
- Allow codeblocks to show only part of the content HOT 2
- Broken anchors: page not scroll to the right section HOT 8
- Index pages cannot be generated with an automatically generated siderbar HOT 1
- Document solution to "docs last update" date being rendered incorrectly when published through Vercel
- Customizing admonitions not work HOT 3
- When testing on StrictMode, the bar remains on the top HOT 1
- Node.js building getting stuck HOT 2
- Updating to @mdx-js/react 3.0.1 causes admonition blocks to stop rendering colored box HOT 8
- The <!--truncate--> line in my long blog post on the initialized website is not causing the blog post size to be limited. HOT 1
- Add trailing slash to auto generated sitemap.xml for directories only HOT 3
- blogTitle not working HOT 4
- Algolia Contextual Search Generates Incorrect FaceFilters HOT 6
- Multi-Instance Routes Not Working in v3.2.1 HOT 3
- Home page renders twice, one below the other. HOT 1
- Details elements aren't searchable - a11y issue HOT 8
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docusaurus.