File tree Expand file tree Collapse file tree 1 file changed +43
-0
lines changed Expand file tree Collapse file tree 1 file changed +43
-0
lines changed Original file line number Diff line number Diff line change @@ -145,3 +145,46 @@ If you are using GitHub pages for hosting, this command is a convenient way to b
145145``` console
146146npm run serve
147147```
148+
149+ ## How to add an author
150+
151+ Add a new author as follows:
152+
153+ * Edit ` docusaurus.config.js ` and add a new author object into the ` authors ` object:
154+
155+ ``` javascript
156+ customFields: {
157+ authors: {
158+ simon: {
159+ name: ' Simon Prickett' ,
160+ link: ' https://twitter.com/simon_prickett' ,
161+ title: ' Manager, Developer Advocacy' ,
162+ image: ' profile_pic_simon_prickett.jpg'
163+ },
164+ suze: {
165+ name: ' Suze Shardlow' ,
166+ link: ' https://twitter.com/SuzeShardlow' ,
167+ title: ' Developer Community Manager'
168+ }
169+ }
170+ },
171+ ```
172+
173+ * Give each author a unique name in the ` authors ` object.
174+ * The ` link ` field can be set to any of your social media profiles or personal website etc.
175+ * The ` image ` field is optional. If omitted, a default silhouette image will be used.
176+ * If providing a value for the ` image ` field, please name your image ` profile_pic_<author_name>.jpg|.png ` and add it to the ` static/img ` folder.
177+ * Make sure that the image is 640px square and use a service such as [ tinypng.com] ( https://tinypng.com/ ) to reduce the file size.
178+ * When you want to tag a document as written by the new author, edit its front matter e.g.:
179+
180+ ``` yaml
181+ ---
182+ id : index-hacktoberfest
183+ title : Hacktoberfest 2021 at Redis
184+ sidebar_label : Hacktoberfest 2021
185+ slug : /hacktoberfest/
186+ authors : [suze,simon]
187+ ---
188+ ```
189+
190+ * Note that multiple authors are supported as shown above.
You can’t perform that action at this time.
0 commit comments