docs: document how to use dargs sphinx directive in markdown files (#77)

inspired by deepmodeling/deepmd-kit#3989

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Documentation**
- Added a code snippet for writing Markdown files using MyST-Parser in
the documentation.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Author: njzjz

docs/sphinx.rst

@@ -30,6 +30,16 @@ A :class:`list` of :class:`Argument <dargs.Argument>` is also accepted.
    :module: dargs._test
    :func: test_arguments
 
+To write Markdown files with `MyST-Parser <https://github.com/executablebooks/MyST-parser>`_, one can use:
+
+.. code-block:: markdown
+
+    ```{eval-rst}
+    .. dargs::
+       :module: dargs._test
+       :func: test_argument
+    ```
+
 Cross-referencing Arguments
 ---------------------------