diff --git a/docs/getting-started-installation.md b/docs/getting-started-installation.md index 73aaf08cfc..dd4b52032d 100644 --- a/docs/getting-started-installation.md +++ b/docs/getting-started-installation.md @@ -31,14 +31,17 @@ Along with previously existing files and directories, your root directory will n ```bash root-directory -├── docs-examples-from-docusaurus +├── Dockerfile +├── README.md +├── docker-compose.yml +├── docs │ ├── doc1.md │ ├── doc2.md │ ├── doc3.md │ ├── exampledoc4.md │ └── exampledoc5.md └── website - ├── blog-examples-from-docusaurus + ├── blog │ ├── 2016-03-11-blog-post.md │ ├── 2017-04-10-blog-post-two.md │ ├── 2017-09-25-testing-rss.md @@ -59,15 +62,13 @@ After running the Docusaurus initialization script, `docusaurus-init` as described in the [Installation](#installing-docusaurus) section, you will have a runnable, example website to use as your site's base. To run: -1. In your root, rename `docs-examples-from-docusaurus` to `docs`. 1. `cd website` -1. Rename `blog-examples-from-docusaurus` to `blog`. 1. From within the `website` directory, run the local webserver using `yarn start` or `npm start`. 1. Load the example site at http://localhost:3000 if it did not already open - automatically. + automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which. - You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the `website` directory will cause the page to refresh. + You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the `website` directory will cause the page to refresh. A randomly generated primary and secondary theme color will be picked for you. ![](/img/getting-started-preparation-verify.png) diff --git a/packages/docusaurus-1.x/examples/basics/blog-examples-from-docusaurus/2016-03-11-blog-post.md b/packages/docusaurus-1.x/examples/basics/blog/2016-03-11-blog-post.md similarity index 100% rename from packages/docusaurus-1.x/examples/basics/blog-examples-from-docusaurus/2016-03-11-blog-post.md rename to packages/docusaurus-1.x/examples/basics/blog/2016-03-11-blog-post.md diff --git a/packages/docusaurus-1.x/examples/basics/blog-examples-from-docusaurus/2017-04-10-blog-post-two.md b/packages/docusaurus-1.x/examples/basics/blog/2017-04-10-blog-post-two.md similarity index 100% rename from packages/docusaurus-1.x/examples/basics/blog-examples-from-docusaurus/2017-04-10-blog-post-two.md rename to packages/docusaurus-1.x/examples/basics/blog/2017-04-10-blog-post-two.md diff --git a/packages/docusaurus-1.x/examples/basics/blog-examples-from-docusaurus/2017-09-25-testing-rss.md b/packages/docusaurus-1.x/examples/basics/blog/2017-09-25-testing-rss.md similarity index 100% rename from packages/docusaurus-1.x/examples/basics/blog-examples-from-docusaurus/2017-09-25-testing-rss.md rename to packages/docusaurus-1.x/examples/basics/blog/2017-09-25-testing-rss.md diff --git a/packages/docusaurus-1.x/examples/basics/blog-examples-from-docusaurus/2017-09-26-adding-rss.md b/packages/docusaurus-1.x/examples/basics/blog/2017-09-26-adding-rss.md similarity index 100% rename from packages/docusaurus-1.x/examples/basics/blog-examples-from-docusaurus/2017-09-26-adding-rss.md rename to packages/docusaurus-1.x/examples/basics/blog/2017-09-26-adding-rss.md diff --git a/packages/docusaurus-1.x/examples/basics/blog-examples-from-docusaurus/2017-10-24-new-version-1.0.0.md b/packages/docusaurus-1.x/examples/basics/blog/2017-10-24-new-version-1.0.0.md similarity index 100% rename from packages/docusaurus-1.x/examples/basics/blog-examples-from-docusaurus/2017-10-24-new-version-1.0.0.md rename to packages/docusaurus-1.x/examples/basics/blog/2017-10-24-new-version-1.0.0.md diff --git a/packages/docusaurus-1.x/examples/basics/docs-examples-from-docusaurus/doc1.md b/packages/docusaurus-1.x/examples/basics/docs/doc1.md similarity index 100% rename from packages/docusaurus-1.x/examples/basics/docs-examples-from-docusaurus/doc1.md rename to packages/docusaurus-1.x/examples/basics/docs/doc1.md diff --git a/packages/docusaurus-1.x/examples/basics/docs-examples-from-docusaurus/doc2.md b/packages/docusaurus-1.x/examples/basics/docs/doc2.md similarity index 100% rename from packages/docusaurus-1.x/examples/basics/docs-examples-from-docusaurus/doc2.md rename to packages/docusaurus-1.x/examples/basics/docs/doc2.md diff --git a/packages/docusaurus-1.x/examples/basics/docs-examples-from-docusaurus/doc3.md b/packages/docusaurus-1.x/examples/basics/docs/doc3.md similarity index 100% rename from packages/docusaurus-1.x/examples/basics/docs-examples-from-docusaurus/doc3.md rename to packages/docusaurus-1.x/examples/basics/docs/doc3.md diff --git a/packages/docusaurus-1.x/examples/basics/docs-examples-from-docusaurus/exampledoc4.md b/packages/docusaurus-1.x/examples/basics/docs/exampledoc4.md similarity index 100% rename from packages/docusaurus-1.x/examples/basics/docs-examples-from-docusaurus/exampledoc4.md rename to packages/docusaurus-1.x/examples/basics/docs/exampledoc4.md diff --git a/packages/docusaurus-1.x/examples/basics/docs-examples-from-docusaurus/exampledoc5.md b/packages/docusaurus-1.x/examples/basics/docs/exampledoc5.md similarity index 100% rename from packages/docusaurus-1.x/examples/basics/docs-examples-from-docusaurus/exampledoc5.md rename to packages/docusaurus-1.x/examples/basics/docs/exampledoc5.md diff --git a/packages/docusaurus-1.x/examples/basics/pages/en/index.js b/packages/docusaurus-1.x/examples/basics/pages/en/index.js index 8f61cde6aa..b50d2cfa72 100644 --- a/packages/docusaurus-1.x/examples/basics/pages/en/index.js +++ b/packages/docusaurus-1.x/examples/basics/pages/en/index.js @@ -60,7 +60,7 @@ class HomeSplash extends React.Component { return ( - +
@@ -105,10 +105,13 @@ class Index extends React.Component { {[ { - content: 'Talk about trying this out', - image: `${baseUrl}img/docusaurus.svg`, + content: + 'To make your landing page more attractive, use illustrations! Check out ' + + '[**Undraw**](https://undraw.co/) which provides you with customizable illustrations which are free to use. ' + + 'The illustrations you see on this page are from Undraw.', + image: `${baseUrl}img/undraw_code_review.svg`, imageAlign: 'left', - title: 'Try it Out', + title: 'Wonderful SVG Illustrations', }, ]} @@ -120,7 +123,7 @@ class Index extends React.Component { { content: 'This is another description of how this project is useful', - image: `${baseUrl}img/docusaurus.svg`, + image: `${baseUrl}img/undraw_note_list.svg`, imageAlign: 'right', title: 'Description', }, @@ -132,10 +135,11 @@ class Index extends React.Component { {[ { - content: 'Talk about learning how to use this', - image: `${baseUrl}img/docusaurus.svg`, + content: + 'Each new Docusaurus project has **randomly-generated** theme colors.', + image: `${baseUrl}img/undraw_youtube_tutorial.svg`, imageAlign: 'right', - title: 'Learn How', + title: 'Randomly Generated Theme Colors', }, ]} @@ -146,13 +150,13 @@ class Index extends React.Component { {[ { content: 'This is the content of my feature', - image: `${baseUrl}img/docusaurus.svg`, + image: `${baseUrl}img/undraw_react.svg`, imageAlign: 'top', title: 'Feature One', }, { content: 'The content of my second feature', - image: `${baseUrl}img/docusaurus.svg`, + image: `${baseUrl}img/undraw_operating_system.svg`, imageAlign: 'top', title: 'Feature Two', }, diff --git a/packages/docusaurus-1.x/examples/basics/siteConfig.js b/packages/docusaurus-1.x/examples/basics/siteConfig.js index b010bbc9da..7c628c9d69 100644 --- a/packages/docusaurus-1.x/examples/basics/siteConfig.js +++ b/packages/docusaurus-1.x/examples/basics/siteConfig.js @@ -13,8 +13,8 @@ const users = [ { caption: 'User1', // You will need to prepend the image path with your baseUrl - // if it is not '/', like: '/test-site/img/docusaurus.svg'. - image: '/img/docusaurus.svg', + // if it is not '/', like: '/test-site/img/image.jpg'. + image: '/img/undraw_open_source.svg', infoLink: 'https://www.facebook.com', pinned: true, }, @@ -48,9 +48,9 @@ const siteConfig = { users, /* path to images for header/footer */ - headerIcon: 'img/docusaurus.svg', - footerIcon: 'img/docusaurus.svg', - favicon: 'img/favicon.png', + headerIcon: 'img/favicon.ico', + footerIcon: 'img/favicon.ico', + favicon: 'img/favicon.ico', /* Colors for website */ colors: { @@ -89,8 +89,8 @@ const siteConfig = { cleanUrl: true, // Open Graph and Twitter card images. - ogImage: 'img/docusaurus.png', - twitterImage: 'img/docusaurus.png', + ogImage: 'img/undraw_online.svg', + twitterImage: 'img/undraw_tweetstorm.svg', // Show documentation's last contributor's name. // enableUpdateBy: true, diff --git a/packages/docusaurus-1.x/examples/basics/static/img/docusaurus.svg b/packages/docusaurus-1.x/examples/basics/static/img/docusaurus.svg deleted file mode 100644 index f80b2217c7..0000000000 --- a/packages/docusaurus-1.x/examples/basics/static/img/docusaurus.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/packages/docusaurus-1.x/examples/basics/static/img/favicon.ico b/packages/docusaurus-1.x/examples/basics/static/img/favicon.ico new file mode 100644 index 0000000000..be74abd69a Binary files /dev/null and b/packages/docusaurus-1.x/examples/basics/static/img/favicon.ico differ diff --git a/packages/docusaurus-1.x/examples/basics/static/img/favicon.png b/packages/docusaurus-1.x/examples/basics/static/img/favicon.png deleted file mode 100644 index 122f0a56c5..0000000000 Binary files a/packages/docusaurus-1.x/examples/basics/static/img/favicon.png and /dev/null differ diff --git a/packages/docusaurus-1.x/examples/basics/static/img/favicon/favicon.ico b/packages/docusaurus-1.x/examples/basics/static/img/favicon/favicon.ico deleted file mode 100644 index eaced0fd8e..0000000000 Binary files a/packages/docusaurus-1.x/examples/basics/static/img/favicon/favicon.ico and /dev/null differ diff --git a/packages/docusaurus-1.x/examples/basics/static/img/undraw_code_review.svg b/packages/docusaurus-1.x/examples/basics/static/img/undraw_code_review.svg new file mode 100644 index 0000000000..0bc19fd56a --- /dev/null +++ b/packages/docusaurus-1.x/examples/basics/static/img/undraw_code_review.svg @@ -0,0 +1 @@ +code review diff --git a/packages/docusaurus-1.x/examples/basics/static/img/undraw_monitor.svg b/packages/docusaurus-1.x/examples/basics/static/img/undraw_monitor.svg new file mode 100644 index 0000000000..b1f954edcc --- /dev/null +++ b/packages/docusaurus-1.x/examples/basics/static/img/undraw_monitor.svg @@ -0,0 +1 @@ +monitor diff --git a/packages/docusaurus-1.x/examples/basics/static/img/undraw_note_list.svg b/packages/docusaurus-1.x/examples/basics/static/img/undraw_note_list.svg new file mode 100644 index 0000000000..3bc32184e5 --- /dev/null +++ b/packages/docusaurus-1.x/examples/basics/static/img/undraw_note_list.svg @@ -0,0 +1 @@ +note list diff --git a/packages/docusaurus-1.x/examples/basics/static/img/undraw_online.svg b/packages/docusaurus-1.x/examples/basics/static/img/undraw_online.svg new file mode 100644 index 0000000000..0057cea28f --- /dev/null +++ b/packages/docusaurus-1.x/examples/basics/static/img/undraw_online.svg @@ -0,0 +1 @@ +online diff --git a/packages/docusaurus-1.x/examples/basics/static/img/undraw_open_source.svg b/packages/docusaurus-1.x/examples/basics/static/img/undraw_open_source.svg new file mode 100644 index 0000000000..59ff351c03 --- /dev/null +++ b/packages/docusaurus-1.x/examples/basics/static/img/undraw_open_source.svg @@ -0,0 +1 @@ +open source diff --git a/packages/docusaurus-1.x/examples/basics/static/img/undraw_operating_system.svg b/packages/docusaurus-1.x/examples/basics/static/img/undraw_operating_system.svg new file mode 100644 index 0000000000..8f0753ec9b --- /dev/null +++ b/packages/docusaurus-1.x/examples/basics/static/img/undraw_operating_system.svg @@ -0,0 +1 @@ +operating system diff --git a/packages/docusaurus-1.x/examples/basics/static/img/undraw_react.svg b/packages/docusaurus-1.x/examples/basics/static/img/undraw_react.svg new file mode 100644 index 0000000000..0f0362ade3 --- /dev/null +++ b/packages/docusaurus-1.x/examples/basics/static/img/undraw_react.svg @@ -0,0 +1 @@ +react diff --git a/packages/docusaurus-1.x/examples/basics/static/img/undraw_tweetstorm.svg b/packages/docusaurus-1.x/examples/basics/static/img/undraw_tweetstorm.svg new file mode 100644 index 0000000000..160a306233 --- /dev/null +++ b/packages/docusaurus-1.x/examples/basics/static/img/undraw_tweetstorm.svg @@ -0,0 +1 @@ +tweetstorm diff --git a/packages/docusaurus-1.x/examples/basics/static/img/undraw_youtube_tutorial.svg b/packages/docusaurus-1.x/examples/basics/static/img/undraw_youtube_tutorial.svg new file mode 100644 index 0000000000..164adc25ca --- /dev/null +++ b/packages/docusaurus-1.x/examples/basics/static/img/undraw_youtube_tutorial.svg @@ -0,0 +1 @@ +youtube tutorial diff --git a/packages/docusaurus-1.x/lib/copy-examples.js b/packages/docusaurus-1.x/lib/copy-examples.js index 9887ce2eee..4d29a803e4 100755 --- a/packages/docusaurus-1.x/lib/copy-examples.js +++ b/packages/docusaurus-1.x/lib/copy-examples.js @@ -69,9 +69,7 @@ if (fs.existsSync(`${CWD}/package.json`)) { const outerFolder = path.basename(path.dirname(CWD)); -let docsCreated = false; -let blogCreated = false; -let exampleSiteCreated = false; +let docsCreatedInIntendedDirectory = true; // handles cases where feature is "translations", "versions" or neither/not present if (feature === 'translations') { @@ -85,7 +83,6 @@ if (feature === 'translations') { ); } else { fs.copySync(`${folder}/crowdin.yaml`, `${CWD}/../crowdin.yaml`); - exampleSiteCreated = true; } const files = glob.sync(`${folder}/**/*`); files.forEach(file => { @@ -101,7 +98,6 @@ if (feature === 'translations') { overwrite: false, errorOnExist: true, }); - exampleSiteCreated = true; } catch (e) { console.log( `${chalk.yellow( @@ -126,7 +122,6 @@ if (feature === 'translations') { overwrite: false, errorOnExist: true, }); - exampleSiteCreated = true; } catch (e) { console.log( `${chalk.yellow( @@ -140,34 +135,28 @@ if (feature === 'translations') { } else { const folder = path.join(__dirname, '..', 'examples', 'basics'); // copy docs examples - if (fs.existsSync(`${CWD}/../docs-examples-from-docusaurus`)) { + let targetDocsDir = `${CWD}/../docs`; + if (fs.existsSync(targetDocsDir)) { console.log( - `- ${chalk.green( - 'docs-examples-from-docusaurus', - )} already exists in ${chalk.blue(outerFolder)}.`, + `- ${chalk.green('docs')} already exists in ${chalk.blue( + outerFolder, + )}. Copying into ${CWD}/../docs-examples-from-docusaurus instead.`, ); - } else { - fs.copySync( - `${folder}/docs-examples-from-docusaurus`, - `${CWD}/../docs-examples-from-docusaurus`, - ); - exampleSiteCreated = true; - docsCreated = true; + targetDocsDir = `${CWD}/../docs-examples-from-docusaurus`; + docsCreatedInIntendedDirectory = false; } + + fs.copySync(`${folder}/docs`, targetDocsDir); + // copy blog examples - if (fs.existsSync(`${CWD}/blog-examples-from-docusaurus`)) { + if (fs.existsSync(`${CWD}/blog`)) { console.log( - `- ${chalk.green( - 'blog-examples-from-docusaurus', - )} already exists in ${chalk.blue(`${outerFolder}/website`)}.`, + `- ${chalk.green('blog')} already exists in ${chalk.blue( + `${outerFolder}/website`, + )}.`, ); } else { - fs.copySync( - path.join(folder, 'blog-examples-from-docusaurus'), - path.join(CWD, 'blog-examples-from-docusaurus'), - ); - exampleSiteCreated = true; - blogCreated = true; + fs.copySync(path.join(folder, 'blog'), path.join(CWD, 'blog')); } const copyFileToProjectFolder = (fileNameFrom, fileNameTo) => { @@ -199,6 +188,7 @@ if (feature === 'translations') { // copy other files const files = glob.sync(`${folder}/**/*`); + const {primaryColor, secondaryColor} = colorScheme(); files.forEach(file => { if (fs.lstatSync(file).isDirectory()) { return; @@ -209,8 +199,8 @@ if (feature === 'translations') { path.basename(file) === 'Dockerfile' || path.basename(file) === 'docker-compose.yml' || path.basename(file) === 'dockerignore' || - containingFolder === 'blog-examples-from-docusaurus' || - containingFolder === 'docs-examples-from-docusaurus' + containingFolder === 'blog' || + containingFolder === 'docs' ) { return; } @@ -219,7 +209,6 @@ if (feature === 'translations') { path.basename(file) === 'siteConfig.js' && !fs.existsSync(CWD + filePath) ) { - const {primaryColor, secondaryColor} = colorScheme(); const siteConfig = fs .readFileSync(file, 'utf8') .replace('{{primaryColor}}', primaryColor) @@ -231,7 +220,6 @@ if (feature === 'translations') { overwrite: false, errorOnExist: true, }); - exampleSiteCreated = true; } catch (e) { console.log( `- ${chalk.green( @@ -246,38 +234,37 @@ if (feature === 'translations') { } }); - if (exampleSiteCreated) { - try { - const tree = require('tree-node-cli'); - const dirString = tree(path.join(CWD, '..'), { - exclude: [ - /node_modules/, // npm - /vendor/, // composer - ], - }); - console.log(dirString); - } catch (error) { - console.warn(`Error printing directory: ${error}`); - } + const svgs = glob.sync(`${CWD}/static/img/**/*.svg`); + svgs.forEach(file => { + // Replace primary colors of SVGs. + const newImage = fs + .readFileSync(file, 'utf8') + .replace(/{{primaryColor}}/g, primaryColor); + fs.writeFileSync(file, newImage); + }); + + try { + const tree = require('tree-node-cli'); + const dirString = tree(path.join(CWD, '..'), { + exclude: [ + /node_modules/, // npm + /vendor/, // composer + ], + }); + console.log(dirString); + } catch (error) { + console.warn(`Error printing directory: ${error}`); } } -if (docsCreated) { +if (!docsCreatedInIntendedDirectory) { console.log( - `Rename ${chalk.yellow( - `${outerFolder}/docs-examples-from-docusaurus`, - )} to ${chalk.yellow( + `The ${chalk.yellow( `${outerFolder}/docs`, - )} to see the example docs on your site.\n`, - ); -} - -if (blogCreated) { - console.log( - `Rename ${chalk.yellow( - `${outerFolder}/website/blog-examples-from-docusaurus`, - )} to ${chalk.yellow( - `${outerFolder}/website/blog`, - )} to see the example blog posts on your site.\n`, + )} directory was not created because it already exists. ` + + `Please manually convert the contents into a Docusaurus-compatible format ` + + `by referring to the examples from ${chalk.yellow( + `${outerFolder}/docs-examples-from-docusaurus`, + )}.\n`, ); }