Promoted articles are a great way to present important articles in your help center. Featured articles can be used in a similar way but are more flexible because you can filter the list of articles not only based on whether or not they’re promoted, but by other properties like labels.
The example below demonstrates the use of a custom article template showing articles with one or more specific labels.
Featured articles by label
View code 9d27e1e9147ff3c9003486192b8af8971ce74ef3718de5b3991b4be447c506f0d8835758636dee858007607718bdf8691606f9654233188c6f8a044029a4eb99f76198e5803a36ba4278114c568ec02c1e9997618c45ea7f91c9ccbf3fc9869907db22b479b545f3f35509b80c117ab891e25c4cd41f536d96e2d031d53b443cf05f5783e3dadf94a168171afcf165b575c2df4d1f841e24e8cf00edbb4791ce92049e823c72ca802204ead4d329c27d4ff3282fbdc5afd0294ff47a9ef400a6b07a0e575a229790a7ddf1b000eec5e2fd21e9288f0b2143841202f54bf79ef9a0f51bb49ad88936e926f96dae803d67e54c8e589a8a97743f559397c20a896f33dbff8a8541713864eeae469199ee4d646912d32d37030d08d548f89f753b24803bd0b1c06049abec41ed919273c1d3d2185305bcb1134710af8317d5791e3a2050b169d35476309b78df2a4672cb7d84d1723a96adedb81d3845dd1a4ab1b262df0b27b300dca3ef1fd9858ccc4685f4697f30f73f910c7dc6746a6d4200d474c29685e7446f2ed72dfe917b7b995f2870c43a6284e4e046fb87644d21d96efd6cc6ab5293b2f53d4f411202caa0134207292759f3db036a5b3706d4fa66241a11d387377ee22c7fdef8c699045fbf7888871c0aa205bcc22dc2debef65efc0d60d029d7683510749ddf48e5e82c17f9c4cc37711e468fac1399d1e2732a3a804cb5912b813bde6da32bb21482cc22c1968f6767748c2e6c6ae6823df11a119cfe988216bdbf957a2b5ab36c7100cf5a9faffb4615d82e1e6ed5bd9d75af7dd8d8b1dce0d684cba63e9153ebca4e11a45748926fc37e4047932811ed2ae3182f8deb68ff54e959a137309f8b339ae52c4be79193f07cba4af1d1382631c14a63c924964c42cef295c1dc0fe7ec3d3b53fc1abdef10c5770934ab7c850d0b14378d1a7f180230d97bf1cfa273cb05da870551b884ef7efb27c4514a520fddbcc792efca797ece1210cb8c26b780c16512e92de8169d544ee72c905f830395fbe42ff91e71b9c5f6d377f04f7f1b34c77580f293faa4b0529b3353051b9d3030b894f18660cb26496f638bd781d8fb9a33fa1dcde62668df45f0776ebbbac806bbffd969cb0e7049cd68cbeeb03be859612eaf8a0d4393105d31eea2c3366c8052aec35e5da842f66e9ac05d67d8441d97af3617959a84bfa5ee69645141fa9388471335e04c9b99508cf9428565ab1f4277449c8a0a55c26bd1a77f2395a329513ea652121b16d6ec9926ce467ec715313fed621b9e58c0c363e40e18f34adc9124eaa4c98b4b68882e1cc437a4b4bfec2fb31d52463c981b69dd48ace5f0fd9a6798441103c3d808616b3dd43a65cb6ad5796986e13c68c9b998065b8fc5e36a31166c31178d6440e44195510b3f2d81fce136b04d60ce80c8219999dbc082d596a6fb4e61d6566acd9e08fe6960fb0209392638ec64cfbf4b9f51702a51bbde37f161c5d8176b6505c06df2f43decf120c4f12a3fda69d154153794edea451e1f8d2e7f819b1fde2e936abf6481d02c9e0c7679bb1b4a611a43dad81733c3c226845966487becfe529237e932285deb3c18d11bf11c37273a7a9e44bc8c2fb1c049d7dacd688d72d5ab73a1072eb705e9fa93313aa6ed1187df98f5b9f925ca8e97d7ff0fbc198b7bcc3e98e870a6f20c280e4a2487585eae915cb93b71648c96361b5484f0b30e92741ec60231893e6a4cb94eec461f26ae37b7d763623bc13241d223c800d74583c23e983ef1351b59f0594f234ae3f777d686262e405772e685fc565a484e88c72e7ff3af4cf63be18e420895b79551efbdae9027d10b9cdb1db9a5adeb03d09c746398db3216ce5565abdcd90275b8a03f11628709e3cf3c9321af82150abae954afc119ca8d51c034c11fd26ff3a86de3727f1059f88280cacbc0fbe7ee64bdbc2f5e886315c870290e058844496f8367430eeff2cbafd39925dafc373899cdf273c7d366215059acc1e003fa2017ffd68f0837ebc2cb05793dbb407587531cbc233638ec2424dbca5aa58ee373e977c2eb57bed73e6bc7d3feff3426a560363618f84e34fdf0af8cee3dab14ca915c32805aedee2bd8930d59a5af2df2a0eaaf6b698d5f858ed605b8ae514025a8144b23f0bd105652ad68e105de14ffdadf33c9cc48ccdcaaa031338eedf998ba560b2a21ef229c8ff3b881ce6b1bfaeaef3d4286b53d06e3a12ad0d68574e8ea3715c0fb778c9a98021d5a6514932b281abfa19cc5e1444262bfd794f66048e3dbe7db1bca33a3a85d215dc8b3d1b60570007f3c888300169c13b4d569793c37ad54ff6798e909ae6756f296269a666698b1afe81a63b396d5bd8a16841540f1704b3b245e5b106b4682226d82fdec797c2b3801581cf05ab9720570355d59963c3d10d142c782ff6efb51d0d6f0b8bb641b3c4b7a40843219ece96c8ab2256a8d5025fa1f949ce434f3cffe76d6b88032cf6a325545ee5a03376fb9596bdb9fce1f9a065240b549701c44daa27a226950f907cf41944a1103d51b62bf7b7c25ee6ace8b8f30c13d2d6ac4ea14d214bb3d37877c0de1eb148c45b53a8b7b260faa9f2c598aaba2e6d09e9054f3f707051cfde4a97ba4f84e27cdec1d2c93ec30285426f8cbe0fb93865fe98ac971ffc8b6d18e15649e7d64ed157729599c5c7099396e0196e7c152e12711fe6c5b034ac21c2c25f41cd1024473117e2d86db634dc4dac223cd1f83e391dd94c16861ff79bbc7fcfaadbeee63d03b0fb3e3e6488c670e3e342ac6d39bee97ecfa5d65506aa37b789344603e395d1c157d0e9e05805a56509f39d1d1d355ca314954524ced9debd7d9d40034aa52ab144b677e9daffdce665b6eaf7776180c2d2af5e05226c95c4b0fbb8012ac82a44229d74711f77bd7ddf5fdf9ddc88aa393032591f4e4fd4ee1ab56d90eeb02f969854f774dbe414d50ee262c1377b063e321e84da0b802de66bf2b9a2fe847692cb7468f814faedd70cad508f3375ed4eade86b7c40353f205556a6fdb6c5d9426fa924e7dd8bd69c98ceb005c8765d46220bd7147969c4bed7e6202a3b5cd935905e86100e212af32d57210e5ae9f5e821b5e04b71dc2ed265a0526dd51cde046b9f70a0e8edd526822934b687d5db3d2fa528ff6656444c3c42bc6d95e2fb6f9a464b5c995a095afb8c17c0336a22c1f484750a9d2e59877cabdf300ca9bffc49ac60a56f372d1df402beec69a6e3990a53d97103cef5587e2d8487eebf610f6d6d531a6780af208ec19386fda6503f191048657778c25f7cf99d49829ced6bdf3bad78338fcace417a2ebac61466194d3a1a15b0d6c2ff90cef6cd9e9c14317171c5236fb37f1f27386bb35ae12d1bf5149b775569ebc88f7bd37a7964fa41dced1f48c6aca25f9f44d35d9dc29a74384e86d55d26333283da69f9d832efdadf8fc3b982f66b19c8951e0c1e68ad1b32363c5c4430d757f20ada835f9695f267c678276c9c7ae38df64c5100eb4508fb133b5a95983a10f261d5b4c558ee4fe931c074e73888bdbdf14c5867316837e3c9816314cd7da138ee25bfc476dc860859f6cee328e3f7f2df4a25d64eb4cc177ef206e44ff15700c90b212dedaa32e2c91b9ad5d531f0194b3bf6ec77728a29bed8e6fcee1603e77fb8022478859fad6d019bff17fdb909d5bfe49229e01aa4739e4feaa5f8e1a3e67a9a8c0725d09c3b70fb7df11ff7f60d10b89e7ad24faf2cc6bb2d9b83bd8dd8daaa39a730ff6defa9432c7494a28e0ac1e66bea1c21335b3ca2e9b03ca3150edd8879176e39814569dbe0ab5c468244079812906810828a85f224aee18a1532b348b830d2f29f09d4d5a4a328019a69ee2bf5993fb077ec42d685a9d3635d6f16ebee77c9bc8f15c1e41d8dcaf7c21c400eeee370b9b51f5aba1afb40129ec9865555f202c9a90677dfc5fc67024efd5b125112042f71030a2c7e3355880154b16c925a39b99971a42895c746d5d0aab423acf27c06295167cc0cca78bf05b2b49c585721ba25265daf0dc2e8cd52c83bd068df058cbc8f5b16f0f8bad787b27dc4f875bd09b5f93bf6488369383d10a47035da7d0cb2dd19877d9c06dac23aaff89998bdda7fef73dcf0b66ab35aec1f9dcd0620671b90576ae58084a5482f55987a7e26339f27002e0c033801670935f11f227c1fd11a1687af8d64dea1532a8a0f36ae1b7929bd67303a748ee9a2760d0f3d65f0b55ec2d625416ed1ce7a4ef5b0ccc71bf03829e890c786fc447902ec8a09c6c75bc2221a85bf903281def2902465bc91147144b7d4ae8f44f4f3bfe62434dee14c521e61781e5b0a464b541ebb654730784f03309857e8623f9d53b9927f1f1a3ca46577b8ffd3b823cfd2ddb138dd9dffb5e5634414f3e8645fc3a1f7e836f9a8071062183e2d4b508bf4df19063f2c404f302d3251ca941bebbafe4c8faaaac4d173110d708eaf69282416644a601721189fc77c081783ebc25f79ef1a99d95b2ef3beafc9e7f03444732209c12120672fcf939b448da993fbd08f6c4c021c9123db000faba9043e6181c51db49a873376d07333c03e435b1ec03c152af1fa4bcb90dd0bd7bf902ba5c11bcb442e490a796ee5d3243833cffc5fb1be270dbeb3fbd9f420e222c5e201234d78f5a61756437f3f618d24f615608b68271aa27a09b0be53850f64278ee68c9da56e326820f056703981a84751954b2435365292f6a83afa19c7c59ffb01cf89a2e76788641cf9b2f97b91c4f8bcdc5bd69b2f7ca2da4f2bc7b123719e746d3e40681076fa77d90a823c2e2bfea6403047ad3e482d9e03c5cf0f2a4648ea1870e6d79cca05f097f2ec6c44e6c8fb4940b92d541f794c21591d9be15e7721441313587b709291fca71aba8549f5e7b9802ee65e6b3e1dcfe3e0e40b324007e3fda1a8ec65daff2f4fc1bf69095132e9631c340b07e2a83217dc8e151dadcee06a764901cfbefaa9c7739f33d5caccc3ebe85ca17a264388fb3997ed86f4a1c2838c579323962c1571b9e250b447bef6c74e44ef892674e5f0b4ce147434b55a82601d73a53fbc8028a9432f7fb051083bb0618b39c7de160c1d4ea1a3c6a908b4541c0fbe93148374f56197e6e54cb0321318005d54f4107857a242553a4405ae729543f5c18ab922177f5a345257832ea50408daf8c428cdff260afbf4a53e0ef3e5fceb72db2a1da1846a5b858f05d
The articles can be filtered and sorted in any way you like, for example by created or updated date or on the basis of how many votes they’ve received.
By making updates to the micro-template you can change the look-and-feel of the list or add new functionality. For different article list styles that you can use with this extension, check out our article list patterns.
The featured article list is displayed using our built-in Navigation extension. You can use the options described on that extension’s page to make additional design or functional changes, regardless of whether you create the article list using attributes or JavaScript.
The example provided uses the data-element="navigation" attribute to create a list of featured articles.
<div data-element="navigation" data-template="featured-articles" data-properties="..." data-template-data="..."></div>
To make design or functional changes you can either edit the default micro-template or replace it with one from our Pattern Library, updating the template ID if necessary.
If data attributes are used within article content you will need to ensure that the allow unsafe HTML setting is enabled within the Zendesk Guide settings.
You can create the list of featured articles using JavaScript:
<div id="featured-articles"></div>
<template id="tmpl-featured-articles">
...
</template>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded', function() {
new Navigation(document.getElementById('featured-articles'), {
properties: [
"id",
"name",
"title",
"body",
"html_url",
"position",
"promoted",
"draft",
"section_id",
"category_id",
"created_at",
"label_names"
],
template: "featured-articles",
templateData: {
heading: "Featured articles",
labels: [ "a_label" ],
excerptLength: 120
}
// Additional options go here
});
});
</script>
The example above supplies the same option values to the plugin as the data-attribute example. This may be desirable if you need to fetch additional data to pass through as templateData before rendering the list.
