diff --git a/website/src/data/users.js b/website/src/data/users.js index 52ad74f66971..3216f5169d2a 100644 --- a/website/src/data/users.js +++ b/website/src/data/users.js @@ -5,8 +5,27 @@ * LICENSE file in the root directory of this source tree. */ +/* + * ADD YOUR SITE TO DOCUSAURUS SHOWCASE: + * + * Instructions + * - add your site in the json array below, in alphabetical order of title + * - add a local image preview (decent screenshot of your Docusaurus site) + * + * The image must be added to the Github repository, and use require("image") + * + * Example PR: https://github.com/facebook/docusaurus/pull/3976 + * + * If you edit this file through the Github interface, you can: + * - Submit first your users.js edit PR + * - This will create a branch on your Docusaurus fork (usually "patch-1") + * - Go to https://github.com//docusaurus/tree//website/src/data/showcase + * - Drag-and-drop an image here to add it to your existing PR + * + */ + +// prettier-ignore const users = [ - // Please add in alphabetical order of title. { title: 'AI-Speaker', description: 'Local, reliable, fast and private Audio and IoT gate.', diff --git a/website/src/pages/showcase/index.js b/website/src/pages/showcase/index.js index 760071f4f08d..411c866536b6 100644 --- a/website/src/pages/showcase/index.js +++ b/website/src/pages/showcase/index.js @@ -17,6 +17,8 @@ import users from '../../data/users'; const TITLE = 'Showcase'; const DESCRIPTION = 'See the awesome websites people are building with Docusaurus'; +const EDIT_URL = + 'https://github.com/facebook/docusaurus/edit/master/website/src/data/users.js'; function Showcase() { return ( @@ -25,6 +27,14 @@ function Showcase() {

{TITLE}

{DESCRIPTION}

+

+ + Add your site! + +

{users.map((user) => (