npm - create-docusaurus - Versions diffs - 0.0.2 → 0.0.3 - Mend

create-docusaurus 0.0.2 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

package/README.md +12 -4
package/bin/index.js +2 -2
package/package.json +2 -1
package/templates/README.md +1 -1
package/templates/facebook/src/pages/index.js +4 -2
package/templates/shared/docs/intro.md +1 -1
package/templates/bootstrap/docusaurus.config.js +0 -93
package/templates/bootstrap/package.json +0 -39
package/templates/bootstrap/src/pages/index.js +0 -87
package/templates/bootstrap/src/pages/styles.module.css +0 -49

package/README.md CHANGED Viewed

@@ -1,6 +1,14 @@
-# `@docusaurus/init`
+# `create-docusaurus`
-Create Docusaurus apps easily.
+Create Docusaurus apps easily with simplified commands:
+```bash
+npm init docusaurus
+```
+```bash
+yarn create docusaurus
+```
 ## Usage
@@ -13,7 +21,7 @@ For Docusaurus maintainers, templates can be tested with:
 ```bash
 cd `git rev-parse --show-toplevel` # Back to repo root
 rm -rf test-website
-yarn docusaurus-init init test-website classic
+yarn create-docusaurus test-website classic
 cd test-website
 yarn start
 ```
@@ -25,7 +33,7 @@ Use the following to test the templates against local packages:
 ```bash
 cd `git rev-parse --show-toplevel` # Back to repo root
 rm -rf test-website-in-workspace
-yarn docusaurus-init init test-website-in-workspace classic
+yarn create-docusaurus test-website-in-workspace classic
 cd test-website-in-workspace
 yarn start
 ```

package/bin/index.js CHANGED Viewed

@@ -36,7 +36,7 @@ program
   .usage('<command> [options]');
 program
-  .command('[siteName] [template] [rootDir]')
+  .command('init [siteName] [template] [rootDir]', {isDefault: true})
   .option('--use-npm')
   .option('--skip-install')
   .option('--typescript')
@@ -59,6 +59,6 @@ program.arguments('<command>').action((cmd) => {
 program.parse(process.argv);
-if (!process.argv.slice(2).length) {
+if (!process.argv.slice(1).length) {
   program.outputHelp();
 }

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "create-docusaurus",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Create Docusaurus apps easily.",
   "repository": {
     "type": "git",
@@ -11,6 +11,7 @@
     "url": "https://github.com/facebook/docusaurus/issues"
   },
   "scripts": {
+    "create-docusaurus": "create-docusaurus",
     "build": "tsc",
     "watch": "tsc --watch"
   },

package/templates/README.md CHANGED Viewed

@@ -1,6 +1,6 @@
 # Templates
-Official templates provided by Docusaurus. They are designed to be selected when using the `npx @docusaurus/init init [name] [template]` CLI command.
+Official templates provided by Docusaurus. They are designed to be selected when using the `npm init docusaurus` CLI command.
 ## Guide to Test Templates for Developer

package/templates/facebook/src/pages/index.js CHANGED Viewed

@@ -69,7 +69,8 @@ export default function Home() {
   return (
     <Layout
       title={`Hello from ${siteConfig.title}`}
-      description="Description will go into a meta tag in <head />">
+      description="Description will go into a meta tag in <head />"
+    >
       <header className={clsx('hero hero--primary', styles.heroBanner)}>
         <div className="container">
           <h1 className="hero__title">{siteConfig.title}</h1>
@@ -80,7 +81,8 @@ export default function Home() {
                 'button button--outline button--secondary button--lg',
                 styles.getStarted,
               )}
-              to={useBaseUrl('docs/')}>
+              to={useBaseUrl('docs/')}
+            >
               Get Started
             </Link>
           </div>

package/templates/shared/docs/intro.md CHANGED Viewed

@@ -17,7 +17,7 @@ Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new
 Generate a new Docusaurus site using the **classic template**:
 ```shell
-npx @docusaurus/init@latest init my-website classic
+npm init docusaurus@latest my-website classic
 ```
 ## Start your site

package/templates/bootstrap/docusaurus.config.js DELETED Viewed

@@ -1,93 +0,0 @@
-// @ts-check
-// Note: type annotations allow type checking and IDEs autocompletion
-/** @type {import('@docusaurus/types').Config} */
-const config = {
-  title: 'My Site',
-  tagline: 'The tagline of my site',
-  url: 'https://your-docusaurus-test-site.com',
-  baseUrl: '/',
-  onBrokenLinks: 'throw',
-  onBrokenMarkdownLinks: 'warn',
-  favicon: 'img/favicon.ico',
-  organizationName: 'facebook', // Usually your GitHub org/user name.
-  projectName: 'docusaurus', // Usually your repo name.
-  themeConfig: {
-    navbar: {
-      title: 'My Site',
-      logo: {
-        alt: 'My Site Logo',
-        src: 'img/logo.svg',
-      },
-      items: [
-        {
-          to: 'docs/intro',
-          activeBasePath: 'docs',
-          label: 'Docs',
-          position: 'left',
-        },
-        {to: 'blog', label: 'Blog', position: 'left'},
-        {
-          href: 'https://github.com/facebook/docusaurus',
-          label: 'GitHub',
-          position: 'right',
-        },
-      ],
-    },
-    footer: {
-      style: 'dark',
-      links: [
-        {
-          title: 'Community',
-          items: [
-            {
-              label: 'Stack Overflow',
-              href: 'https://stackoverflow.com/questions/tagged/docusaurus',
-            },
-            {
-              label: 'Discord',
-              href: 'https://discordapp.com/invite/docusaurus',
-            },
-            {
-              label: 'Twitter',
-              href: 'https://twitter.com/docusaurus',
-            },
-          ],
-        },
-        {
-          title: 'More',
-          items: [
-            {
-              label: 'Blog',
-              to: 'blog/',
-            },
-            {
-              label: 'GitHub',
-              href: 'https://github.com/facebook/docusaurus',
-            },
-          ],
-        },
-      ],
-      copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
-    },
-  },
-  presets: [
-    [
-      '@docusaurus/preset-bootstrap',
-      {
-        docs: {
-          sidebarPath: require.resolve('./sidebars.js'),
-          editUrl: 'https://github.com/facebook/docusaurus/edit/main/website/',
-        },
-        blog: {
-          showReadingTime: true,
-          // Please change this to your repo.
-          editUrl:
-            'https://github.com/facebook/docusaurus/edit/main/website/blog/',
-        },
-      },
-    ],
-  ],
-};
-module.exports = config;

package/templates/bootstrap/package.json DELETED Viewed

@@ -1,39 +0,0 @@
-{
-  "name": "docusaurus-2-bootstrap-template",
-  "version": "2.0.0-beta.6",
-  "private": true,
-  "scripts": {
-    "docusaurus": "docusaurus",
-    "start": "docusaurus start",
-    "build": "docusaurus build",
-    "swizzle": "docusaurus swizzle",
-    "deploy": "docusaurus deploy",
-    "clear": "docusaurus clear",
-    "serve": "docusaurus serve",
-    "write-translations": "docusaurus write-translations",
-    "write-heading-ids": "docusaurus write-heading-ids"
-  },
-  "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.6",
-    "@docusaurus/preset-bootstrap": "2.0.0-beta.6",
-    "@mdx-js/react": "^1.6.21",
-    "@svgr/webpack": "^5.5.0",
-    "clsx": "^1.1.1",
-    "file-loader": "^6.2.0",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1",
-    "url-loader": "^4.1.1"
-  },
-  "browserslist": {
-    "production": [
-      ">0.2%",
-      "not dead",
-      "not op_mini all"
-    ],
-    "development": [
-      "last 1 chrome version",
-      "last 1 firefox version",
-      "last 1 safari version"
-    ]
-  }
-}

package/templates/bootstrap/src/pages/index.js DELETED Viewed

@@ -1,87 +0,0 @@
-import React from 'react';
-import clsx from 'clsx';
-import Layout from '@theme/Layout';
-import Link from '@docusaurus/Link';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import useBaseUrl from '@docusaurus/useBaseUrl';
-import styles from './styles.module.css';
-const features = [
-  {
-    title: 'Easy to Use',
-    imageUrl: 'img/undraw_docusaurus_mountain.svg',
-    description: (
-      <>
-        Docusaurus was designed from the ground up to be easily installed and
-        used to get your website up and running quickly.
-      </>
-    ),
-  },
-  {
-    title: 'Focus on What Matters',
-    imageUrl: 'img/undraw_docusaurus_tree.svg',
-    description: (
-      <>
-        Docusaurus lets you focus on your docs, and we&apos;ll do the chores. Go
-        ahead and move your docs into the <code>docs</code> directory.
-      </>
-    ),
-  },
-  {
-    title: 'Powered by React',
-    imageUrl: 'img/undraw_docusaurus_react.svg',
-    description: (
-      <>
-        Extend or customize your website layout by reusing React. Docusaurus can
-        be extended while reusing the same header and footer.
-      </>
-    ),
-  },
-];
-function Feature({imageUrl, title, description}) {
-  const imgUrl = useBaseUrl(imageUrl);
-  return (
-    <div className={clsx('col col--4', styles.feature)}>
-      {imgUrl && (
-        <div className="text--center">
-          <img className={styles.featureImage} src={imgUrl} alt={title} />
-        </div>
-      )}
-      <h3>{title}</h3>
-      <p>{description}</p>
-    </div>
-  );
-}
-export default function Home() {
-  const context = useDocusaurusContext();
-  const {siteConfig = {}} = context;
-  return (
-    <Layout
-      title={`Hello from ${siteConfig.title}`}
-      description="Description will go into a meta tag in <head />">
-      <div className={styles.hero}>
-        <header>
-          <h1>{siteConfig.title}</h1>
-          <p>{siteConfig.tagline}</p>
-          <div className={styles.buttons}>
-            <Link to={useBaseUrl('docs/')}>Get Started</Link>
-          </div>
-        </header>
-        <main>
-          {features && features.length > 0 && (
-            <section className={styles.section}>
-              <div className={styles.features}>
-                {features.map((props, idx) => (
-                  <Feature key={idx} {...props} />
-                ))}
-              </div>
-            </section>
-          )}
-        </main>
-      </div>
-    </Layout>
-  );
-}

package/templates/bootstrap/src/pages/styles.module.css DELETED Viewed

@@ -1,49 +0,0 @@
-/* stylelint-disable docusaurus/copyright-header */
-/**
- * CSS files with the .module.css suffix will be treated as CSS modules
- * and scoped locally.
- */
-.heroBanner {
-  padding: 4rem 0;
-  text-align: center;
-  position: relative;
-  overflow: hidden;
-}
-@media screen and (max-width: 966px) {
-  .heroBanner {
-    padding: 2rem;
-  }
-}
-.buttons {
-  display: flex;
-  align-items: center;
-  justify-content: center;
-}
-.hero {
-  display: flex;
-  flex-direction: column;
-  width: 100%;
-  align-items: center;
-  place-content: center;
-}
-.section {
-  margin: 10rem;
-}
-.features {
-  display: flex;
-  align-items: center;
-  padding: 2rem 0;
-  width: 100%;
-}
-.featureImage {
-  height: 200px;
-  width: 200px;
-}