{"Status":true,"Message":"","Response":{"post":{"postuid":"4539fe66-19d9-42b1-9b4c-2526b2ddee99","tenantuid":"d8b744fc-2e70-4089-bb80-dd1d08f6c7b2","projectuid":"fc6490ac-7527-4f49-b06e-46f701280e85","title":"Project Settings","slug":"article/project-settings-1","html":"\u003Cp\u003EEach project has its own settings for branding, content defaults, integrations, custom code and more. To open them, select your project and click \u003Cb\u003ESettings\u003C/b\u003E in the left navigation. The \u003Cb\u003EProject Settings\u003C/b\u003E page is split into tabs.\u003C/p\u003E\u003Cp\u003ENew to HelpGuides? Start with \u003Ca href=\u0022/welcome\u0022\u003EWelcome to HelpGuides.io\u003C/a\u003E, then come back here to finish setting up your project.\u003C/p\u003E\u003Ch2 id=\u0022general\u0022\u003EGeneral\u003C/h2\u003E\u003Cp\u003EThe \u003Cb\u003EGeneral\u003C/b\u003E tab controls how your project looks and whether search engines can index it. Click \u003Cb\u003EUpdate\u003C/b\u003E to save your changes. The logo and favicon save as soon as you upload them.\u003C/p\u003E\u003Cfigure\u003E\u003Cimg class=\u0022lazy-load\u0022 data-src=\u0022https://graffiti-auf7e6dwhxhcbwek.z03.azurefd.net/d8b744fc-2e70-4089-bb80-dd1d08f6c7b2/fc6490ac-7527-4f49-b06e-46f701280e85/images/29dc3e470a994157a0a1fd63f4eebe95.png?v=-362533407\u0022 data-width=\u00221150\u0022 data-height=\u0022760\u0022 style=\u0022max-width: 100%;\u0022 alt=\u0022Project Settings, General tab with title, welcome message, application domain and brand logo\u0022/\u003E\u003Cfigcaption\u003ESettings, General tab\u003C/figcaption\u003E\u003C/figure\u003E\u003Ctable border=\u00221\u0022 style=\u0022border-collapse: collapse; width: 100%;\u0022\u003E\u003Cthead\u003E\u003Ctr\u003E\u003Cth\u003ESetting\u003C/th\u003E\u003Cth\u003EWhat it does\u003C/th\u003E\u003C/tr\u003E\u003C/thead\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Cb\u003ETitle\u003C/b\u003E\u003C/td\u003E\u003Ctd\u003EThe name of your site, up to 60 characters. It\u0027s required.\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Cb\u003EWelcome Message\u003C/b\u003E\u003C/td\u003E\u003Ctd\u003EA short message, up to 800 characters, shown at the root of your documentation.\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Cb\u003EApplication Domain\u003C/b\u003E\u003C/td\u003E\u003Ctd\u003EThe address your project is published at, for example \u003Ccode\u003Eyourproject.helpguides.io\u003C/code\u003E. Click the link to open your site.\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Cb\u003EBrand Logo\u003C/b\u003E\u003C/td\u003E\u003Ctd\u003EThe logo shown on your site.\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Cb\u003EFav Icon Logo\u003C/b\u003E\u003C/td\u003E\u003Ctd\u003EThe small icon browsers show in the tab.\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Cb\u003EPrimary Color\u003C/b\u003E\u003C/td\u003E\u003Ctd\u003EYour brand color. HelpGuides also uses it to tint this project\u0027s sidebar in the admin, which helps you tell projects apart.\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Cb\u003EDefault Post Type\u003C/b\u003E\u003C/td\u003E\u003Ctd\u003EThe type used for new posts: \u003Cb\u003EArticle\u003C/b\u003E, \u003Cb\u003EAPI Reference\u003C/b\u003E or \u003Cb\u003EBlog Post\u003C/b\u003E.\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Cb\u003EAllow Search Engine Indexing\u003C/b\u003E\u003C/td\u003E\u003Ctd\u003EWhen on, search engines may index your content. When off, your site\u0027s \u003Ccode\u003Erobots.txt\u003C/code\u003E tells crawlers not to index anything.\u003C/td\u003E\u003C/tr\u003E\u003C/table\u003E\u003Ccite class=\u0022recommended\u0022\u003E\u003Cspan class=\u0022title\u0022\u003ENew projects start hidden from search engines\u003C/span\u003E\u003Cp\u003E\u003Cb\u003EAllow Search Engine Indexing\u003C/b\u003E is off when you create a project, so you can set it up before it\u0027s public. Turn it on when you\u0027re ready to launch. \u003Ccode\u003Erobots.txt\u003C/code\u003E is cached, so the change can take up to three hours to show there. See \u003Ca href=\u0022/article/bing-webmaster-tools\u0022\u003EBing Webmaster Tools\u003C/a\u003E for submitting your sitemap.\u003C/p\u003E\u003C/cite\u003E\u003Ch3 id=\u0022changing_your_domain\u0022\u003EChanging your domain\u003C/h3\u003E\u003Cp\u003EEvery project gets a \u003Ccode\u003Ehelpguides.io\u003C/code\u003E subdomain based on the project\u0027s name. Next to \u003Cb\u003EApplication Domain\u003C/b\u003E, \u003Cb\u003EChange\u003C/b\u003E opens the \u003Cb\u003EChange subdomain or add a custom domain\u003C/b\u003E dialog, which has a \u003Cb\u003ESubdomain\u003C/b\u003E field and a \u003Cb\u003ECustom domain\u003C/b\u003E field.\u003C/p\u003E\u003Cp\u003EAt the moment, changes made in this dialog aren\u0027t saved. To change your subdomain or publish your project on your own domain, contact support. If you want your documentation to appear under a path on your existing website, for example \u003Ccode\u003Eexample.com/docs\u003C/code\u003E, see \u003Ca href=\u0022/article/setup-reverse-proxy\u0022\u003ESetup Reverse Proxy\u003C/a\u003E.\u003C/p\u003E\u003Ch2 id=\u0022content\u0022\u003EContent\u003C/h2\u003E\u003Cp\u003EThe \u003Cb\u003EContent\u003C/b\u003E tab sets defaults for new articles and chooses which optional blocks appear in the editor. Click \u003Cb\u003ESave\u003C/b\u003E to apply your changes.\u003C/p\u003E\u003Ch3 id=\u0022content_defaults\u0022\u003EContent Defaults\u003C/h3\u003E\u003Cul\u003E\u003Cli\u003E\u003Cb\u003EDefault Featured Image\u003C/b\u003E: upload the image to use when an article has no featured image of its own.\u003C/li\u003E\u003Cli\u003E\u003Cb\u003EDefault Featured Image Enabled\u003C/b\u003E: when on, and a default featured image is set, articles and posts without a featured image use it automatically.\u003C/li\u003E\u003C/ul\u003E\u003Ch3 id=\u0022editor_widgets\u0022\u003EEditor Widgets\u003C/h3\u003E\u003Cp\u003EThese optional blocks are off by default. Turn on the ones your team needs and they appear in the editor\u0027s block menu.\u003C/p\u003E\u003Cfigure\u003E\u003Cimg class=\u0022lazy-load\u0022 data-src=\u0022https://graffiti-auf7e6dwhxhcbwek.z03.azurefd.net/d8b744fc-2e70-4089-bb80-dd1d08f6c7b2/fc6490ac-7527-4f49-b06e-46f701280e85/images/caebce8e5f934e2d8b136b17b45c6e29.png?v=-338579386\u0022 data-width=\u00221150\u0022 data-height=\u00221300\u0022 style=\u0022max-width: 100%;\u0022 alt=\u0022Settings Content tab with the default featured image and the Editor Widgets switches\u0022/\u003E\u003Cfigcaption\u003ESettings, Content tab\u003C/figcaption\u003E\u003C/figure\u003E\u003Ctable border=\u00221\u0022 style=\u0022border-collapse: collapse; width: 100%;\u0022\u003E\u003Cthead\u003E\u003Ctr\u003E\u003Cth\u003EWidget\u003C/th\u003E\u003Cth\u003EAdds\u003C/th\u003E\u003C/tr\u003E\u003C/thead\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Cb\u003EEmail Widget\u003C/b\u003E\u003C/td\u003E\u003Ctd\u003EAn Email block for mock email previews with subject, from, to and body fields.\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Cb\u003ESMS Widget\u003C/b\u003E\u003C/td\u003E\u003Ctd\u003EAn SMS block for mock text message previews with from, to and message fields.\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Cb\u003EHTML\u003C/b\u003E\u003C/td\u003E\u003Ctd\u003EAn HTML block for inserting custom HTML directly into content.\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Cb\u003ECode\u003C/b\u003E\u003C/td\u003E\u003Ctd\u003EA Code block for syntax-highlighted code snippets.\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Cb\u003EREST API\u003C/b\u003E\u003C/td\u003E\u003Ctd\u003EA REST API block for documenting API endpoints with method, URL and response details.\u003C/td\u003E\u003C/tr\u003E\u003C/table\u003E\u003Cp\u003EFor what each block does and how to use it, see the \u003Ca href=\u0022/article/editor-blocks-reference\u0022\u003EEditor Blocks Reference\u003C/a\u003E.\u003C/p\u003E\u003Ch2 id=\u0022integrations\u0022\u003EIntegrations\u003C/h2\u003E\u003Cp\u003EThe \u003Cb\u003EIntegrations\u003C/b\u003E tab connects HelpGuides with other applications.\u003C/p\u003E\u003Cul\u003E\u003Cli\u003E\u003Cb\u003EGoogle Analytics\u003C/b\u003E: enter your Google Analytics measurement ID, for example \u003Ccode\u003EG-XXXXXXXXXX\u003C/code\u003E, and click \u003Cb\u003ESave\u003C/b\u003E. HelpGuides adds the Google tag to your published pages.\u003C/li\u003E\u003Cli\u003E\u003Cb\u003ESlack\u003C/b\u003E: click \u003Cb\u003EAdd to Slack\u003C/b\u003E to post a message to a channel when an article is published, and let your team ask questions with \u003Ccode\u003E/helpguides\u003C/code\u003E or by mentioning \u003Ccode\u003E@HelpGuides\u003C/code\u003E. Once connected, you choose a \u003Cb\u003ENotification Channel\u003C/b\u003E and whether to \u003Cb\u003ENotify on updates\u003C/b\u003E. See \u003Ca href=\u0022/article/connecting-slack\u0022\u003EConnecting Slack\u003C/a\u003E for the full setup.\u003C/li\u003E\u003C/ul\u003E\u003Cfigure\u003E\u003Cimg class=\u0022lazy-load\u0022 data-src=\u0022https://graffiti-auf7e6dwhxhcbwek.z03.azurefd.net/d8b744fc-2e70-4089-bb80-dd1d08f6c7b2/fc6490ac-7527-4f49-b06e-46f701280e85/images/1a91ea01242e4732b45ab9d2bdf4a012.png?v=-340420367\u0022 data-width=\u00221150\u0022 data-height=\u0022620\u0022 style=\u0022max-width: 100%;\u0022 alt=\u0022Settings Integrations tab with the Google Analytics ID and the Add to Slack button\u0022/\u003E\u003Cfigcaption\u003ESettings, Integrations tab\u003C/figcaption\u003E\u003C/figure\u003E\u003Ch2 id=\u0022page_header_and_page_footer\u0022\u003EPage Header and Page Footer\u003C/h2\u003E\u003Cp\u003EUse the \u003Cb\u003EPage Header\u003C/b\u003E and \u003Cb\u003EPage Footer\u003C/b\u003E tabs to add your own HTML to the top and bottom of every page on your site, for example your company\u0027s navigation bar, links back to your main website, or a copyright notice.\u003C/p\u003E\u003Col\u003E\u003Cli\u003EOpen the \u003Cb\u003EPage Header\u003C/b\u003E or \u003Cb\u003EPage Footer\u003C/b\u003E tab.\u003C/li\u003E\u003Cli\u003EType or paste your HTML into the code editor.\u003C/li\u003E\u003Cli\u003ECheck the live preview above the editor. It updates as you type and applies the CSS from the \u003Cb\u003ECode\u003C/b\u003E tab.\u003C/li\u003E\u003Cli\u003EClick \u003Cb\u003ESave\u003C/b\u003E.\u003C/li\u003E\u003C/ol\u003E\u003Cfigure\u003E\u003Cimg class=\u0022lazy-load\u0022 data-src=\u0022https://graffiti-auf7e6dwhxhcbwek.z03.azurefd.net/d8b744fc-2e70-4089-bb80-dd1d08f6c7b2/fc6490ac-7527-4f49-b06e-46f701280e85/images/c6f3ea9f9bfd4956b6db6cc9f04981b6.png?v=-348624831\u0022 data-width=\u00221150\u0022 data-height=\u0022900\u0022 style=\u0022max-width: 100%;\u0022 alt=\u0022Page Header tab with a live preview above the HTML editor\u0022/\u003E\u003Cfigcaption\u003ESettings, Page Header tab\u003C/figcaption\u003E\u003C/figure\u003E\u003Ch2 id=\u0022code\u0022\u003ECode\u003C/h2\u003E\u003Cp\u003EThe \u003Cb\u003ECode\u003C/b\u003E tab adds custom CSS and JavaScript to every page on your site. Both editors take HTML tags, not bare code. Click \u003Cb\u003ESave\u003C/b\u003E to apply both.\u003C/p\u003E\u003Ctable border=\u00221\u0022 style=\u0022border-collapse: collapse; width: 100%;\u0022\u003E\u003Cthead\u003E\u003Ctr\u003E\u003Cth\u003EEditor\u003C/th\u003E\u003Cth\u003EWhat to enter\u003C/th\u003E\u003Cth\u003EWhere it\u0027s added\u003C/th\u003E\u003C/tr\u003E\u003C/thead\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Cb\u003ECSS\u003C/b\u003E\u003C/td\u003E\u003Ctd\u003E\u003Ccode\u003E\u0026lt;style\u0026gt;\u003C/code\u003E blocks, or \u003Ccode\u003E\u0026lt;link rel=\u0022stylesheet\u0022\u0026gt;\u003C/code\u003E tags that load a .css file\u003C/td\u003E\u003Ctd\u003EThe page \u003Ccode\u003E\u0026lt;head\u0026gt;\u003C/code\u003E\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Cb\u003EJavaScript\u003C/b\u003E\u003C/td\u003E\u003Ctd\u003E\u003Ccode\u003E\u0026lt;script\u0026gt;\u003C/code\u003E blocks, or \u003Ccode\u003E\u0026lt;script src=\u0022...\u0022\u0026gt;\u0026lt;/script\u0026gt;\u003C/code\u003E tags that load a .js file\u003C/td\u003E\u003Ctd\u003EThe end of the page\u003C/td\u003E\u003C/tr\u003E\u003C/table\u003E\u003Cfigure\u003E\u003Cimg class=\u0022lazy-load\u0022 data-src=\u0022https://graffiti-auf7e6dwhxhcbwek.z03.azurefd.net/d8b744fc-2e70-4089-bb80-dd1d08f6c7b2/fc6490ac-7527-4f49-b06e-46f701280e85/images/00b084bb67e54b0b9a2474aacce7dbdd.png?v=-325514209\u0022 data-width=\u00221150\u0022 data-height=\u0022900\u0022 style=\u0022max-width: 100%;\u0022 alt=\u0022Code tab with the CSS editor\u0022/\u003E\u003Cfigcaption\u003ESettings, Code tab\u003C/figcaption\u003E\u003C/figure\u003E\u003Cdiv class=\u0022code_wrapper\u0022\u003E\u003Cdiv class=\u0022code\u0022 data-language=\u0022html\u0022\u003E\u0026lt;style\u0026gt;\n  :root { --brand: #217ce8; }\n  h2 { color: var(--brand); }\n\u0026lt;/style\u0026gt;\n\u0026lt;link rel=\u0026quot;stylesheet\u0026quot; href=\u0026quot;https://example.com/docs-theme.css\u0026quot;\u0026gt;\u003C/div\u003E\u003C/div\u003E\u003Ccite class=\u0022warning\u0022\u003E\u003Cspan class=\u0022title\u0022\u003EKeep the default stylesheet\u003C/span\u003E\u003Cp\u003ENew projects start with a Bootstrap stylesheet link in the CSS editor. If you remove it, your header and footer HTML may lose styling that depends on it.\u003C/p\u003E\u003C/cite\u003E\u003Ch2 id=\u0022import__export\u0022\u003EImport / Export\u003C/h2\u003E\u003Cp\u003EThe \u003Cb\u003EImport / Export\u003C/b\u003E tab backs up all of your posts as a .zip file and imports content from HubSpot and HelpDocs. See \u003Ca href=\u0022/article/importing-and-exporting-content\u0022\u003EImporting and Exporting Content\u003C/a\u003E.\u003C/p\u003E\u003Ch2 id=\u0022advanced\u0022\u003EAdvanced\u003C/h2\u003E\u003Cp\u003EThe \u003Cb\u003EAdvanced\u003C/b\u003E tab holds settings that change how your whole site behaves. Use them with caution. The two switches save as soon as you change them.\u003C/p\u003E\u003Cfigure\u003E\u003Cimg class=\u0022lazy-load\u0022 data-src=\u0022https://graffiti-auf7e6dwhxhcbwek.z03.azurefd.net/d8b744fc-2e70-4089-bb80-dd1d08f6c7b2/fc6490ac-7527-4f49-b06e-46f701280e85/images/a9ee50b0059548619d486371de48c2fb.png?v=-330961469\u0022 data-width=\u00221150\u0022 data-height=\u0022720\u0022 style=\u0022max-width: 100%;\u0022 alt=\u0022Advanced tab with Canonical Path, Force Trailing Slash, Import External Images, Refresh Link Index and Delete Project\u0022/\u003E\u003Cfigcaption\u003ESettings, Advanced tab\u003C/figcaption\u003E\u003C/figure\u003E\u003Ctable border=\u00221\u0022 style=\u0022border-collapse: collapse; width: 100%;\u0022\u003E\u003Cthead\u003E\u003Ctr\u003E\u003Cth\u003ESetting\u003C/th\u003E\u003Cth\u003EWhat it does\u003C/th\u003E\u003C/tr\u003E\u003C/thead\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Cb\u003ECanonical Path\u003C/b\u003E\u003C/td\u003E\u003Ctd\u003EThe address search engines treat as the real home of your content. When you serve your documentation through a reverse proxy, this is your own domain and path, for example \u003Ccode\u003Ehttps://example.com/docs\u003C/code\u003E. Contact support to set or change it. See \u003Ca href=\u0022/article/setup-reverse-proxy\u0022\u003ESetup Reverse Proxy\u003C/a\u003E.\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Cb\u003EForce Trailing Slash\u003C/b\u003E\u003C/td\u003E\u003Ctd\u003EWhen on, every article URL ends with a slash, for example \u003Ccode\u003E/my-post/\u003C/code\u003E. Turn this on when you migrate from WordPress so your existing URLs keep working.\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Cb\u003EImport External Images\u003C/b\u003E\u003C/td\u003E\u003Ctd\u003EWhen on, images in articles that are hosted elsewhere are downloaded and served from the HelpGuides CDN when the article is saved. If a download fails, the original image URL is kept.\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Cb\u003ERefresh Internal Link Index\u003C/b\u003E\u003C/td\u003E\u003Ctd\u003EClick \u003Cb\u003ERefresh Link Index\u003C/b\u003E to crawl all published articles and rebuild the index of links between them, which the backlink tracking and SEO reports use. It runs in the background and can take a few minutes.\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd\u003E\u003Cb\u003EPermanently Delete Project\u003C/b\u003E\u003C/td\u003E\u003Ctd\u003EClick \u003Cb\u003EDelete Project\u003C/b\u003E to delete the project. See below.\u003C/td\u003E\u003C/tr\u003E\u003C/table\u003E\u003Ch3 id=\u0022deleting_a_project\u0022\u003EDeleting a project\u003C/h3\u003E\u003Col\u003E\u003Cli\u003EOn the \u003Cb\u003EAdvanced\u003C/b\u003E tab, click \u003Cb\u003EDelete Project\u003C/b\u003E.\u003C/li\u003E\u003Cli\u003EIn the \u003Cb\u003EConfirm Delete\u003C/b\u003E dialog, type the project\u0027s name exactly as it appears in \u003Cb\u003ETitle\u003C/b\u003E. The name is case-sensitive.\u003C/li\u003E\u003Cli\u003EClick \u003Cb\u003EDelete\u003C/b\u003E. You\u0027re taken back to \u003Cb\u003EAll Projects\u003C/b\u003E, where the project shows as \u003Cb\u003EDeleted\u003C/b\u003E.\u003C/li\u003E\u003C/ol\u003E\u003Cp\u003EA deleted project is scheduled to be permanently deleted. Until then, anyone on your team can open it from \u003Cb\u003EAll Projects\u003C/b\u003E and click \u003Cb\u003EReactivate Project\u003C/b\u003E. See \u003Ca href=\u0022/article/managing-projects\u0022\u003EManaging Projects\u003C/a\u003E.\u003C/p\u003E\u003Ch2 id=\u0022api_keys\u0022\u003EAPI Keys\u003C/h2\u003E\u003Cp\u003EThe \u003Cb\u003EAPI Keys\u003C/b\u003E tab creates keys for the HelpGuides REST API. Each key has a name and a set of permissions. See \u003Ca href=\u0022/article/api-keys-and-the-rest-api\u0022\u003EAPI Keys and the REST API\u003C/a\u003E.\u003C/p\u003E\u003Ch2 id=\u0022other_settings\u0022\u003EOther settings\u003C/h2\u003E\u003Cp\u003ESome project settings live on their own pages in the left navigation. \u003Cb\u003EAI Settings\u003C/b\u003E includes the switch for your project\u0027s Model Context Protocol (MCP) server; see \u003Ca href=\u0022/article/model-context-protocol\u0022\u003EModel Context Protocol\u003C/a\u003E. Settings for the chat messenger are in \u003Cb\u003EInbox\u003C/b\u003E; see \u003Ca href=\u0022/article/setting-up-chat\u0022\u003ESetting Up Chat\u003C/a\u003E.\u003C/p\u003E","publish_status":0,"post_type":"Article","authoruid":"3dde8c16-763a-4a2b-ae0b-1d8c50c62e3d","author":{"authoruid":"3dde8c16-763a-4a2b-ae0b-1d8c50c62e3d"},"featured_image_updating":false,"meta_description":"Manage your HelpGuides project settings: branding, content defaults, integrations, custom code, API keys, and advanced options to customize your documentation site.","display_toc":true,"has_workingcopy":false,"allow_indexing":true,"sort_order":1,"total_views":0,"date_published":"2026-10-04T21:45:23.793","date_updated":"2026-10-04T21:45:24.51","date_created":"2026-09-28T16:18:35.903"}}}