1"use strict";(self.webpackChunkforem_admin=self.webpackChunkforem_admin||[]).push([[3124],{3905:function(e,t,n){n.d(t,{Zo:function(){return u},kt:function(){return p}});var r=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){o(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,r,o=function(e,t){if(null==e)return{};var n,r,o={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var m=r.createContext({}),c=function(e){var t=r.useContext(m),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},u=function(e){var t=c(e.components);return r.createElement(m.Provider,{value:t},e.children)},l={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,m=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),d=c(n),p=o,f=d["".concat(m,".").concat(p)]||d[p]||l[p]||i;return n?r.createElement(f,a(a({ref:t},u),{},{components:n})):r.createElement(f,a({ref:t},u))}));function p(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,a=new Array(i);a[0]=d;var s={};for(var m in t)hasOwnProperty.call(t,m)&&(s[m]=t[m]);s.originalType=e,s.mdxType="string"==typeof e?e:o,a[1]=s;for(var c=2;c<i;c++)a[c]=n[c];return r.createElement.apply(null,a)}return r.createElement.apply(null,n)}d.displayName="MDXCreateElement"},8267:function(e,t,n){n.r(t),n.d(t,{default:function(){return u},frontMatter:function(){return a},metadata:function(){return s},toc:function(){return m}});var r=n(7462),o=n(3366),i=(n(7294),n(3905)),a={description:"Forem Admin Docs Contributing and Style Guide.",sidebar_position:2},s={unversionedId:"community-resources/style-guide",id:"community-resources/style-guide",isDocsHomePage:!1,title:"Contributing\xa0and\xa0Style\xa0Guide",description:"Forem Admin Docs Contributing and Style Guide.",source:"@site/docs/community-resources/style-guide.md",sourceDirName:"community-resources",slug:"/community-resources/style-guide",permalink:"/docs/community-resources/style-guide",editUrl:"https://github.com/forem/admin-docs/edit/main/docs/community-resources/style-guide.md",version:"current",sidebarPosition:2,frontMatter:{description:"Forem Admin Docs Contributing and Style Guide.",sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"Connecting with Forem Creators and Admins",permalink:"/docs/community-resources/connect-with-forem-builders"},next:{title:"Submit a Bug Report",permalink:"/docs/community-resources/submit-bug-report"}},m=[{value:"Naming\xa0Conventions",id:"naming-conventions",children:[{value:"Examples",id:"examples",children:[]}]},{value:"File\xa0Extension",id:"file-extension",children:[]}],c={toc:m};function u(e){var t=e.components,n=(0,o.Z)(e,["components"]);return(0,i.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("div",{className:"admonition admonition-important alert alert--info"},(0,i.kt)("div",{parentName:"div",className:"admonition-heading"},(0,i.kt)("h5",{parentName:"div"},(0,i.kt)("span",{parentName:"h5",className:"admonition-icon"},(0,i.kt)("svg",{parentName:"span",xmlns:"http://www.w3.org/2000/svg",width:"14",height:"16",viewBox:"0 0 14 16"},(0,i.kt)("path",{parentName:"svg",fillRule:"evenodd",d:"M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"}))),"important")),(0,i.kt)("div",{parentName:"div",className:"admonition-content"},(0,i.kt)("p",{parentName:"div"},"We're in the middle of some fast-moving changes to the Forem Admin experience, so we've paused documentation updates for the time being. You may find that the docs are now outdated in parts. If you have any questions, please visit ",(0,i.kt)("a",{parentName:"p",href:"https://forem.dev"},"forem.dev")," to request additional support. We thank you for your patience and hope you're liking the changes!"))),(0,i.kt)("p",null,"Thanks\xa0for\xa0your\xa0interest\xa0in\xa0contributing\xa0to\xa0Forem's\xa0Adm
1in\xa0Documentation!\xa0\nBefore getting\xa0started,\xa0we'd\xa0like\xa0you\xa0to\xa0review\xa0our\xa0contributing\xa0and\xa0style\xa0guide. Afterward, please visit our ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/forem/admin-docs#forem-admin-docs"},"Forem Admin Docs repo")," and ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/forem/admin-docs/issues/new/choose"},"submit an issue")," using one of our templates."),(0,i.kt)("h2",{id:"naming-conventions"},"Naming\xa0Conventions"),(0,i.kt)("p",null,"When\xa0naming\xa0files\xa0we\xa0should\xa0opt\xa0for\xa0kebab\xa0case,\xa0",(0,i.kt)("inlineCode",{parentName:"p"},"kebab-case"),",\xa0in\xa0order\xa0to\xa0remain\nconsistent\xa0and\xa0clear.\xa0This\xa0rule\xa0applies\xa0for\xa0folders\xa0as\xa0well.\xa0However,\xa0before\xa0creating\na\xa0folder,\xa0it'd\xa0be\xa0best\xa0to\xa0check\xa0in\xa0with\xa0the\xa0Community\xa0Success\xa0team\xa0at\xa0\n",(0,i.kt)("a",{parentName:"p",href:"https://forem.dev"},"forem.dev"),"\xa0for\xa0organizational\xa0purposes."),(0,i.kt)("h3",{id:"examples"},"Examples"),(0,i.kt)("p",null,"Document\xa0Title:\xa0User\xa0Roles\xa0>\xa0",(0,i.kt)("inlineCode",{parentName:"p"},"user-roles.md")),(0,i.kt)("p",null,"Document\xa0Title:\xa0Pages\xa0>\xa0",(0,i.kt)("inlineCode",{parentName:"p"},"pages.md")),(0,i.kt)("p",null,"Document\xa0Title:\xa0Connecting\xa0with\xa0Forem\xa0Creators\xa0and\xa0Admins\xa0\xa0> ",(0,i.kt)("br",null),"\n",(0,i.kt)("inlineCode",{parentName:"p"},"connecting-with-forem-creators-and-admins.md")),(0,i.kt)("p",null,"With\xa0a\xa0longer\xa0title,\xa0it'd\xa0also\xa0be\xa0acceptable\xa0to\xa0shorted\xa0the\xa0slug(or\xa0file\xa0name).\xa0For\nexample\xa0we\xa0could\xa0shorten\xa0the\xa0name\xa0to:\xa0",(0,i.kt)("inlineCode",{parentName:"p"},"connect-forem-creators.md")),(0,i.kt)("h2",{id:"file-extension"},"File\xa0Extension"),(0,i.kt)("p",null,"We'll\xa0always\xa0be\xa0using\xa0the\xa0markdown,\xa0",(0,i.kt)("inlineCode",{parentName:"p"},".md"),",\xa0extension\xa0-\xa0see\xa0Examples\xa0above."))}u.isMDXComponent=!0}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.