README.md

   1 Welcome to FOSDEM 2021. This year, we have an experimental digital-only setup for reasons I think you all know.
   2
   3 ## General structure
   4
   5 The stands.fosdem.org exhibition website is a static website generated with [Hugo](https://gohugo.io/). There is a general part,
   6 created by FOSDEM, containing an overview of each stand, a thematic ordering and some general information, and a stand-specific part.
   7
   8 We create the general part and will seed the stand-specific part with what you provided during your submission in the _\_index.md_. You can
   9 update the contents of the file, but please make sure you do not remove any of the variables in the _[front matter](https://gohugo.io/content-management/front-matter/)_, otherwise the generator
  10 will crash.
  11
  12 We've asked for two repositories from you, one with the content (Hugo content files) and one with static files. These repositories do not have
  13 to contain anything else but .md (or .html) files and images respectively. The stand pages will keep the theme we created.
  14
  15 However, if you wish to provide an added experience, you can link to other pages on your own website. We ask however that you (a) keep the stand
  16 information on stands.fosdem.org, that (b) you make sure that visitors know they are not longer on the FOSDEM website and (c) they can easily go back to stands.fosdem.org (e.g. to look at other stands).
  17
  18 The structure in your directories is flat (no hierarchy in sub folders). If you wish to create additional hierarchical subfolders, please contact us
  19 and we will set it up.
  20
  21 We automatically generate a link to your video repository and the chatroom.
  22
  23 Your stand will live under _stands.fosdem.org/stands/<your project>_.
  24
  25 ## Directory structure
  26
  27 We will clone the repositories you provided in two locations (corresponding to the path _stands/<your stand>_).
  28
  29  * `content/stands/<your stand>` - location of the content files ([Hugo documentation](https://gohugo.io/content-management/organization/)).
  30  * `static/stands/<your stand>` - location of any static files (images, logo's, etc.).
  31
  32 ## Important files
  33
  34 ### _index.md
  35
  36  * `content/stands/<your stand>/_index.md` - generated by our custom highly advanced (;-)) script based on what you provided in your submission.
  37
  38 The contents of the _\_index.md_ file can be changed as you wish, but please make sure you do not remove any of the variables (changing the content
  39 is fine) of the _front matter_, otherwise the generator will not work. Please do not change the theme or the layout.
  40
  41 #### Front matter
  42
  43 ```
  44 ---
  45 title: _Project_
  46 themes:
  47  - _Theme (please do not change from the one already in the repository)_
  48 website: _Your website_
  49 logo: stands/_Project_/_Logo filename_
  50 description: |
  51     _Short description of your project (5 lines)_
  52
  53 showcase: |
  54     _Showcase: explain why people should come to your stand. You can use HTML (p, ul, etc.)_
  55
  56 new_this_year: |
  57     _What has happened in 2020 to your project? You can use HTML (p, ul, etc.)_
  58
  59 layout: stand
  60 ---
  61 ```
  62
  63 ### Any other files
  64
  65 All other files can by any content Hugo accepts (HTML, MD).
  66
  67
  68 ## Technical details
  69
  70 Whatever you put as content of any file (or the contents of _\_index.md_) will appear in the resulting HTML page as follows.
  71 ```
  72 <html>
  73 <head>
  74 [FOSDEM Head]
  75 </head>
  76 <body>
  77 [FOSDEM Header]
  78 <div class="container">
  79     <div class="row">
  80         <div class="col">
  81             <nav aria-label="breadcrumb">
  82                 <ol class="breadcrumb">
  83                    [FOSDEM Generated breadcrumb]
  84                 </ol>
  85             </nav>
  86         </div>
  87     </div>
  88     <div class="row">
  89         <div class="col">
  90             [Your content]
  91         </div>
  92     </div>
  93 </div>
  94 [FOSDEM Footer]
  95 </body>
  96 </html>
  97 ```
  98
  99 We use Bootstrap (4.5) for styling, so you can as well. jQuery is included (for Bootstrap), so you can use it.
 100
 101 Please note that you cannot load any assets (images, css or js) from any other domain than stands.fosdem.org.
 102
 103 ## Feedback
 104 We realise this is certainly not the best possible option, but while we are fairly confident we can organise a physical edition,
 105 going virtual is new for us as well. If you have any ideas for improvements, feedback or anything else, please contact us
 106 at _stands\_at\_fosdem\_dot\_org_. Or open a pull request ;-)